Skip to main content

RateLimit

Enum RateLimit 

Source
pub enum RateLimit {
    Rfc6585(Headers),
    RetryAfter(RateLimit),
}
Expand description

Rate Limit information, parsed from HTTP headers.

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

Variants§

§

Rfc6585(Headers)

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

§

RetryAfter(RateLimit)

Rate limit information as per the Retry-After header.

Implementations§

Source§

impl RateLimit

Source

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

Create a new RateLimit from a http::HeaderMap.

Source

pub const fn reset(&self) -> ResetTime

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

Source

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.

Source

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

Get remaining value.

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

Trait Implementations§

Source§

impl Clone for RateLimit

Source§

fn clone(&self) -> RateLimit

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLimit

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for RateLimit

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for RateLimit

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for RateLimit

Source§

impl StructuralPartialEq for RateLimit

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.