Struct RateLimit 

pub struct RateLimit {
    pub limit: Option<u64>,
    pub remaining: Option<u64>,
    pub reset_at: Option<OffsetDateTime>,
    pub retry_after: Option<Duration>,
}

What a service told us about our remaining budget.

Parsed once, here, from the three conventions that cover almost every API in practice: the IETF RateLimit-* draft headers, the widespread X-RateLimit-* variants, and plain Retry-After.

Fields

limit: Option<u64>

Requests allowed in the current window.

remaining: Option<u64>

Requests still available.

reset_at: Option<OffsetDateTime>

When the window resets.

retry_after: Option<Duration>

How long the service asked us to wait before retrying.

Implementations

impl RateLimit

pub fn from_headers(headers: &Headers, now: OffsetDateTime) -> Self

Read rate-limit metadata from response headers.

now is needed because Retry-After and some reset headers are relative; it comes from the Clock port so this stays testable.

pub fn is_exhausted(&self) -> bool

Whether the budget is exhausted.

pub fn wait_for(&self, now: OffsetDateTime) -> Option<Duration>

How long to wait before the next attempt, if the service said anything useful.

pub fn is_present(&self) -> bool

Whether this response carried any rate-limit information at all.

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 Copy for RateLimit

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl Default for RateLimit

fn default() -> RateLimit

Returns the “default value” for a type.

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