Struct TotalQty

pub(super) struct TotalQty {
    raw: ByteQty,
}

Total used, TotalQtyNotifier.total_used, found in State.total_used.

Can be “poisoned”, preventing further claims. (We mark it poisoned if the reclamation task crashes, since in that situation we don’t want to continue to use memory, unboundedly.)

Fields

raw: ByteQty

See BookkeptQty

Implementations

impl TotalQty

pub(super) fn claim( &mut self, p_used: &mut ParticipQty, want: Qty, ) -> Option<ClaimedQty>

Claim a quantity, increasing the tracked amounts

This module doesn’t know anything about the memory quota, so this doesn’t do the quota check.

The only caller is Participation::claim.

pub(super) fn release(&mut self, p_used: &mut ParticipQty, have: ClaimedQty)

Release a quantity, decreasing the tracked amounts

(Handles underflow by saturating; returning an error is not going to be useful.)

pub(super) fn set_poisoned(&mut self)

Declare this poisoned, and prevent further claims

Trait Implementations

impl BookkeepableQty for TotalQty

const ZERO: TotalQty

Zero (default value)

fn as_raw(&self) -> Qty

Inspect as a raw untracked Qty

impl BookkeptQty for TotalQty

fn from_raw(q: Qty) -> Self

Make a new bookkept quantity from a raw untracked Qty

fn into_raw(self) -> Qty

Unwrap into a raw untracked Qty

impl Debug for TotalQty

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TotalQty

fn default() -> TotalQty

Returns the “default value” for a type.

impl DefaultExtTake for TotalQty

fn take(&mut self) -> Self

Returns *self, replacing it with the default value.

impl Display for TotalQty

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Rhs: BookkeepableQty> PartialEq<Rhs> for TotalQty

fn eq(&self, other: &Rhs) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Rhs: BookkeepableQty> PartialOrd<Rhs> for TotalQty

fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.