Struct RateLimit

pub struct RateLimit {
    pub limit: usize,
    pub remaining: usize,
    pub reset: ResetTime,
    pub window: Option<Duration>,
    pub vendor: Vendor,
}

HTTP rate limits as parsed from header values

Fields

limit: usize

The maximum number of requests allowed in the time window

remaining: usize

The number of requests remaining in the time window

reset: ResetTime

The time at which the rate limit will be reset

window: Option<Duration>

The time window until the rate limit is lifted. It is optional, because it might not be given, in which case it needs to be inferred from the environment

vendor: Vendor

Predicted vendor based on rate limit header

Implementations

impl RateLimit

pub fn new<T: Into<CaseSensitiveHeaderMap>>(headers: T) -> Result<Self, Error>

Extracts rate limits from HTTP headers separated by newlines

There are different header names for various websites Github, Vimeo, Twitter, Imgur, etc have their own headers. Without additional context, the parsing is done on a best-effort basis.

pub const fn limit(&self) -> usize

Get the number of requests allowed in the time window

pub const fn remaining(&self) -> usize

Get the number of requests remaining in the time window

pub const fn reset(&self) -> ResetTime

Get the time at which the rate limit will be reset

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a duplicate of the value.

const 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 FromStr for RateLimit

type Err = Error

The associated error which can be returned from parsing.

fn from_str(map: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl PartialEq for RateLimit

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

impl StructuralPartialEq for RateLimit