Struct RateLimit 

pub struct RateLimit {
    pub limit: u64,
    pub used: u64,
    pub remaining: u64,
    pub reset_after: Duration,
    pub exceeded: bool,
}

The outcome of one attempt, and everything the X-RateLimit-* headers need.

Fields

limit: u64

The configured ceiling for the window.

used: u64

How many attempts this key has made in the current window.

remaining: u64

How many remain. Zero once the limit is reached.

reset_after: Duration

How long until the window resets — what Retry-After reports.

exceeded: bool

Whether this attempt was refused.

Implementations

impl RateLimit

pub fn retry_after_seconds(&self) -> u64

Retry-After is expressed in whole seconds and must never be 0, or a client reads it as “retry immediately” and hammers straight back.

pub fn reset_at(&self) -> u64

The Unix timestamp at which the window resets, for X-RateLimit-Reset.

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl Eq for RateLimit

impl PartialEq for RateLimit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RateLimit