Struct egg_mode::RateLimit

pub struct RateLimit {
    pub limit: i32,
    pub remaining: i32,
    pub reset: i32,
}

Rate limit information returned with a Response.

With every API call, Twitter returns information about how many times you're allowed to call that endpoint, and at what point your limit refreshes and allows you to call it more. These are normally passed through the response headers, and egg-mode reads for these headers when a function returns a Response<T>. If the headers are absent for a given request, the field will be -1.

Rate limits are tracked separately based on the kind of Token you're using. For Bearer tokens using Application-only authentication, the rate limit is based on your application as a whole, regardless of how many instances are using that token. For Access tokens, the rate limit is broken down by-user, so more-active users will not use up the rate limit for less-active ones.

For more information about rate-limiting, see Twitter's documentation about rate limits.

Fields

limit: i32

The rate limit ceiling for the given request.

remaining: i32

The number of requests left for the 15-minute window.

reset: i32

The UTC Unix timestamp at which the rate window resets.

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a copy 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<'de> Deserialize<'de> for RateLimit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'_> TryFrom<&'_ HeaderMap<HeaderValue>> for RateLimit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(headers: &Headers) -> Result<Self>

Performs the conversion.