Struct RateLimitHeaders 

pub struct RateLimitHeaders {
    pub bucket: Vec<u8>,
    pub limit: u16,
    pub remaining: u16,
    pub reset_at: Instant,
}

Parsed user response rate limit headers.

A limit of zero marks the Bucket as exhausted until reset_at elapses.

Global limits

Please open an issue if the RateLimiter exceeded the global limit.

Shared limits

You may preemptively exhaust the bucket until Reset-After by completing the Permit with RateLimitHeaders::shared, but are not required to since these limits do not count towards the invalid request limit.

Fields

bucket: Vec<u8>

Bucket identifier.

limit: u16

Total number of requests until the bucket becomes exhausted.

remaining: u16

Number of remaining requests until the bucket becomes exhausted.

reset_at: Instant

Time at which the bucket resets.

Implementations

impl RateLimitHeaders

pub const BUCKET: &'static str = "x-ratelimit-bucket"

Lowercased name for the bucket header.

pub const LIMIT: &'static str = "x-ratelimit-limit"

Lowercased name for the limit header.

pub const REMAINING: &'static str = "x-ratelimit-remaining"

Lowercased name for the remaining header.

pub const RESET_AFTER: &'static str = "x-ratelimit-reset-after"

Lowercased name for the reset-after header.

pub const SCOPE: &'static str = "x-ratelimit-scope"

Lowercased name for the scope header.

pub fn shared(bucket: Vec<u8>, retry_after: u16) -> Self

Emulates a shared resource limit as a user limit by setting limit and remaining to zero.

Trait Implementations

impl Clone for RateLimitHeaders

fn clone(&self) -> RateLimitHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitHeaders

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

Formats the value using the given formatter.

impl Hash for RateLimitHeaders

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RateLimitHeaders

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

impl StructuralPartialEq for RateLimitHeaders