Enum RateLimitDecision 

pub enum RateLimitDecision {
    Unlimited,
    Allowed {
        remaining: u32,
        charge: RateLimitCharge,
    },
    Limited {
        retry_after: Duration,
    },
}

What the limiter decided about one request.

Three variants rather than Result<remaining, retry_after> because a limiter that is switched off has no remaining count to report, and folding that case into Ok(max_requests) is what put X-RateLimit-Remaining: 100 on every response of a server started with --no-rate-limit. A limit that does not exist cannot be advertised if it cannot be represented.

Variants

Unlimited

No limit was applied — the limiter is disabled.

Allowed

Allowed, with this many requests left in the current window.

Fields

remaining: u32

Requests left in the current window.

charge: RateLimitCharge

The slot this request took, for a handler that may refund it.

Limited

Refused; the window frees up after this long.

Fields

retry_after: Duration

Implementations

impl RateLimitDecision

pub fn remaining(&self) -> Option<u32>

Requests left in the window, where a count exists at all.

Trait Implementations

impl Clone for RateLimitDecision

fn clone(&self) -> RateLimitDecision

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateLimitDecision

impl Debug for RateLimitDecision

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

Formats the value using the given formatter.

impl Eq for RateLimitDecision

impl PartialEq for RateLimitDecision

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RateLimitDecision