Struct RateLimit 

pub struct RateLimit { /* private fields */ }

A structure containing information about the current speed limit for a particular key.

Implementations

impl RateLimit

pub fn get_remaining_tokens(&self) -> usize

Returns the number of tokens available.

pub fn get_retry_after(&self) -> DateTime<Local>

If the tokens have run out, this method will return the time after which at least one token will be available.

pub fn is_accepted(&self) -> bool

Returns a result reflecting whether this request was executed within the current limit.

pub fn get_limit(&self) -> usize

TODO doc

pub fn ensure_accepted(&self) -> Result<(), RateLimitExceededError>

Same as Self::is_accepted(), but will return Err(RateLimitExceededError) if the request failed within the current limit.

Trait Implementations

impl Debug for RateLimit

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

Formats the value using the given formatter.