Struct twilight_http_ratelimiting::ticket::TicketNotifier

pub struct TicketNotifier(_);

Indicate to the ratelimit consumer that their ticket has been granted and they may now send a request.

Implementations

impl TicketNotifier

pub fn available(self) -> Option<TicketHeaders>

Signal to the ratelimiter consumer (an HTTP client) that a request may now be performed.

A receiver is returned. This must be stored and awaited so that ratelimiting backends can handle the headers that the API consumer will send back, thus completing the cycle.

Returns a None if the consumer has dropped their TicketReceiver half. The ticket is considered canceled.

Trait Implementations

impl Debug for TicketNotifier

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

Formats the value using the given formatter.