Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Discord HTTP client API rate limiter.

The RateLimiter runs an associated actor task to concurrently handle permit requests and responses.

Cloning a RateLimiter increments just the amount of senders for the actor. The actor completes when there are no senders and non-completed permits left.

Implementations

impl RateLimiter

pub fn new(global_limit: u16) -> Self

Create a new RateLimiter with a custom global limit.

pub fn acquire(&self, endpoint: Endpoint) -> PermitFuture

Await a single permit for this endpoint.

Permits are queued per endpoint in the order they were requested.

pub fn acquire_if<P>( &self, endpoint: Endpoint, predicate: P, ) -> MaybePermitFuture

where P: FnOnce(Option<Bucket>) -> bool + Send + 'static,

Await a single permit for this endpoint, but only if the predicate evaluates to true.

Permits are queued per endpoint in the order they were requested.

Note that the predicate is asynchronously called in the actor task.

Example

use twilight_http_ratelimiting::{Endpoint, Method};

let endpoint = Endpoint {
    method: Method::Get,
    path: String::from("applications/@me"),
};
if let Some(permit) = rate_limiter
    .acquire_if(endpoint, |b| b.is_none_or(|b| b.remaining > 10))
    .await
{
    let headers = unimplemented!("GET /applications/@me");
    permit.complete(headers);
}

pub async fn bucket(&self, endpoint: Endpoint) -> Option<Bucket>

Retrieve the Bucket for this endpoint.

The bucket is internally retrieved via acquire_if.

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimiter

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

Formats the value using the given formatter.

impl Default for RateLimiter

fn default() -> Self

Create a new RateLimiter with Discord’s default global limit.

Currently this is 50.