Struct RateLimitVariant

pub struct RateLimitVariant {
    pub vendor: Vendor,
    pub duration: Option<Duration>,
    pub limit_header: Option<String>,
    pub used_header: Option<String>,
    pub remaining_header: String,
    pub reset_header: String,
    pub reset_kind: ResetTimeKind,
}

A variant defines all relevant fields for parsing headers from a given vendor

Fields

vendor: Vendor

Vendor of the rate limit headers (e.g. Github, Twitter, etc.)

duration: Option<Duration>

Duration of the rate limit interval

limit_header: Option<String>

Header name for the maximum number of requests

used_header: Option<String>

Header name for the number of used requests

remaining_header: String

Header name for the number of remaining requests

reset_header: String

Header name for the reset time

reset_kind: ResetTimeKind

Kind of reset time

Implementations

impl RateLimitVariant

pub const fn new( vendor: Vendor, duration: Option<Duration>, limit_header: Option<String>, used_header: Option<String>, remaining_header: String, reset_header: String, reset_kind: ResetTimeKind, ) -> Self

Create a new rate limit variant

Trait Implementations

impl Clone for RateLimitVariant

fn clone(&self) -> RateLimitVariant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitVariant

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

Formats the value using the given formatter.

impl PartialEq for RateLimitVariant

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

Tests for self and other values to be equal, and is used by ==.

const 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 StructuralPartialEq for RateLimitVariant