Struct Ratelimit

pub struct Ratelimit { /* private fields */ }

A set of data containing information about the ratelimits for a particular RatelimitingBucket, which is stored in Http.

See the Discord docs on ratelimits for more information.

Note: You should not mutate any of the fields, as this can help cause 429s.

Implementations

impl Ratelimit

pub async fn pre_hook( &mut self, req: &Request<'_>, ratelimit_callback: &(dyn Fn(RatelimitInfo) + Send + Sync), )

pub async fn post_hook( &mut self, response: &Response, req: &Request<'_>, ratelimit_callback: &(dyn Fn(RatelimitInfo) + Send + Sync), absolute_ratelimits: bool, ) -> Result<bool>

pub const fn limit(&self) -> i64

The total number of requests that can be made in a period of time.

pub const fn remaining(&self) -> i64

The number of requests remaining in the period of time.

pub const fn reset(&self) -> Option<SystemTime>

The absolute time in milliseconds when the interval resets.

pub const fn reset_after(&self) -> Option<Duration>

The total time in milliseconds when the interval resets.

Trait Implementations

impl Debug for Ratelimit

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

Formats the value using the given formatter.

impl Default for Ratelimit

fn default() -> Self

Returns the “default value” for a type.