Struct ClaimedQty

pub(super) struct ClaimedQty {
    raw: ByteQty,
    bomb: DropBombCondition,
}

“Cached” claim, on behalf of a Participant

Found in Participation.cache, and accounted to the Participant (ie, included in ParticipQty).

Also used as a temporary variable in claim() and release() functions. When we return to the participant, outside the tracker, we essentially throw this away, since we don’t give the caller any representation to store. The participant is supposed to track this separately somehow.

Fields

raw: ByteQty

See BookkeptQty

bomb: DropBombCondition

See BookkeptQty

Implementations

impl ClaimedQty

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

Split a ClaimedQty into two ClaimedQtys

pub(super) fn merge_into(&mut self, have: ClaimedQty)

Merge two ClaimedQtys

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

pub(super) fn claim_return_to_participant(self) -> Result<()>

Obtain result for the participant, after having successfully recorded the amount claimed

CORRECTNESS

This must be called only on a successful return path from Participation::claim.

pub(super) fn release_got_from_participant(got: Qty) -> Self

When the participant indicates a release, enrol the amount in our bookkeeping scheme

Handles the quantity argument to Participation::release.

CORRECTNESS

This must be called only on entry to Participation::release.

pub(super) fn dispose_participant_destroyed(self)

Dispose of a quantity that was claimed by a now-destroyed participant

CORRECTNESS

The ParticipQty this was claimed from must also have been destroyed.

So, ParticipQty::for_participant_teardown and the corresponding release must have been called earlier - possibly, much earlier.

Trait Implementations

impl BookkeepableQty for ClaimedQty

const ZERO: ClaimedQty

Zero (default value)

fn as_raw(&self) -> Qty

Inspect as a raw untracked Qty

impl BookkeptQty for ClaimedQty

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 ClaimedQty

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

Formats the value using the given formatter.

impl Default for ClaimedQty

fn default() -> ClaimedQty

Returns the “default value” for a type.

impl DefaultExtTake for ClaimedQty

fn take(&mut self) -> Self

Returns *self, replacing it with the default value.

impl Display for ClaimedQty

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

Formats the value using the given formatter.

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

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

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

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 ClaimedQty

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.