Enum BudgetCheckResult 

pub enum BudgetCheckResult {
    Allowed {
        remaining: u64,
    },
    Exhausted {
        retry_after_secs: u64,
    },
    Soft {
        remaining: i64,
        over_by: u64,
    },
}

Result of a budget check operation.

Variants

Allowed

Request is allowed within budget

Fields

remaining: u64

Tokens remaining after this request

Exhausted

Budget is exhausted

Fields

retry_after_secs: u64

Seconds until the period resets

Soft

Request allowed via burst allowance (soft limit)

Fields

remaining: i64

Tokens remaining (negative means over budget)

over_by: u64

Amount over the base limit

Implementations

impl BudgetCheckResult

pub fn is_allowed(&self) -> bool

Returns true if the request should be allowed.

pub fn retry_after_secs(&self) -> u64

Returns the retry-after value in seconds, or 0 if allowed.

Trait Implementations

impl Clone for BudgetCheckResult

fn clone(&self) -> BudgetCheckResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetCheckResult

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

Formats the value using the given formatter.

impl PartialEq for BudgetCheckResult

fn eq(&self, other: &BudgetCheckResult) -> 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 StructuralPartialEq for BudgetCheckResult