Enum HeaderName

#[non_exhaustive]
pub enum HeaderName {
    Bucket,
    Global,
    Limit,
    Remaining,
    ResetAfter,
    Reset,
    RetryAfter,
    Scope,
}

Typed name of a header.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bucket

Information about the ratelimit bucket.

Global

Global header.

Limit

Maximum requests allotted in the bucket.

Remaining

Remaining requested allotted.

ResetAfter

How long until the bucket is reset.

Reset

When the bucket resets.

RetryAfter

How long until a request can be tried again.

Scope

Scope of a ratelimit.

Implementations

impl HeaderName

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

Lowercased name for the bucket header.

pub const GLOBAL: &'static str = "x-ratelimit-global"

Lowercased name for the global 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 RESET: &'static str = "x-ratelimit-reset"

Lowercased name for the reset header.

pub const RETRY_AFTER: &'static str = "retry-after"

Lowercased name for the retry-after header.

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

Lowercased name for the scope header.

pub const fn name(self) -> &'static str

Lowercased name of the header.

Trait Implementations

impl Clone for HeaderName

fn clone(&self) -> HeaderName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderName

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

Formats the value using the given formatter.

impl Display for HeaderName

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

Formats the value using the given formatter.

impl PartialEq for HeaderName

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

impl Eq for HeaderName

impl StructuralPartialEq for HeaderName