Enum RateLimit 

pub enum RateLimit {
    Rfc6585(Headers),
    RetryAfter(RateLimit),
}

Rate Limit information, parsed from HTTP headers.

There are multiple ways to represent rate limit information in HTTP headers. The following variants are supported:

• IETF “Polly” draft
• Retry-After

Variants

Rfc6585(Headers)

Rate limit information as per the [IETF “Polly” draft][ietf].

RetryAfter(RateLimit)

Rate limit information as per the [Retry-After][retryafter] header.

Implementations

impl RateLimit

pub fn new(headers: &HeaderMap) -> Result<Self, Error>

Create a new RateLimit from a http::HeaderMap.

pub fn extract<'a, I>(headers: I) -> Result<Self, Error>

where I: IntoIterator<Item = (&'a str, &'a str)> + Clone,

Create a new RateLimit from an iterator over HTTP headers.

pub const fn is_limited(&self) -> bool

Check if the rate limit has been reached.

pub fn status(&self) -> Status

Get the current status of the rate limit.

pub const fn reset(&self) -> ResetTime

Get reset time. This is the time when the rate limit will be reset.

pub const fn limit(&self) -> Option<usize>

Get limit value.

This is the maximum number of requests that can be made in a given time window.

pub const fn remaining(&self) -> Option<usize>

Get remaining value.

This is the number of requests remaining in the current time window.

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 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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RateLimit