Enum AcquireOutcome 

pub enum AcquireOutcome {
    Granted,
    Denied {
        retry_at: DateTime<Utc>,
    },
}

The result of attempting to consume one token from a RateLease. A pure function of the lease’s state + now.

Variants

Granted

A token was consumed — the budgeted effect MAY proceed.

Denied

The quota is exhausted. retry_at is the earliest instant a token will be available again (the input to on_exhausted: defer’s reschedule).

Fields

retry_at: DateTime<Utc>

Implementations

impl AcquireOutcome

pub fn is_granted(&self) -> bool

Trait Implementations

impl Clone for AcquireOutcome

fn clone(&self) -> AcquireOutcome

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AcquireOutcome

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

Formats the value using the given formatter.

impl PartialEq for AcquireOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AcquireOutcome