Struct InMemoryRatelimiter

pub struct InMemoryRatelimiter { /* private fields */ }

Default ratelimiter implementation used in twilight that stores ratelimit information in an in-memory mapping.

This will meet most users’ needs for simple ratelimiting, but for multi-processed bots, consider either implementing your own Ratelimiter that uses a shared storage backend or use the HTTP proxy.

Implementations

impl InMemoryRatelimiter

pub fn new() -> Self

Create a new in-memory ratelimiter.

This is used by HTTP client to queue requests in order to avoid hitting the API’s ratelimits.

Trait Implementations

impl Clone for InMemoryRatelimiter

fn clone(&self) -> InMemoryRatelimiter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InMemoryRatelimiter

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

Formats the value using the given formatter.

impl Default for InMemoryRatelimiter

fn default() -> InMemoryRatelimiter

Returns the “default value” for a type.

impl Ratelimiter for InMemoryRatelimiter

fn bucket(&self, path: &Path) -> GetBucketFuture

Retrieve the basic information of the bucket for a given path.

fn is_globally_locked(&self) -> IsGloballyLockedFuture

Whether the ratelimiter is currently globally locked.

fn has(&self, path: &Path) -> HasBucketFuture

Determine if the ratelimiter has a bucket for the given path.

fn ticket(&self, path: Path) -> GetTicketFuture

Retrieve a ticket to know when to send a request. The provided future will be ready when a ticket in the bucket is available. Tickets are ready in order of retrieval.

fn wait_for_ticket(&self, path: Path) -> WaitForTicketFuture

Retrieve a ticket to send a request. Other than Self::ticket, this method will return a TicketSender.