Struct ClaimedTokens 

pub struct ClaimedTokens<'a, I> { /* private fields */ }

A handle to a number of claimed tokens.

Dropping this handle will commit the claim.

Implementations

impl<'a, I> ClaimedTokens<'a, I>

pub fn commit(self) -> BecameEmpty

Commit the claimed tokens.

This is equivalent to just dropping the ClaimedTokens, but also returns whether the token bucket became empty or not.

pub fn reduce(&mut self, count: u64) -> Result<(), InsufficientTokensError>

Reduce the claim to a fewer number of tokens than the original claim.

If count is larger than the original claim, an error will be returned containing the current number of claimed tokens.

pub fn discard(self)

Discard the claim.

This does not remove any tokens from the token bucket.

Trait Implementations

impl<'a, I: Debug> Debug for ClaimedTokens<'a, I>

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

Formats the value using the given formatter.

impl<'a, I> Drop for ClaimedTokens<'a, I>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.