Struct twilight_gateway_queue::InMemoryQueue

pub struct InMemoryQueue { /* private fields */ }

Memory based Queue implementation backed by an efficient background task.

InMemoryQueue::update allows for dynamically changing the queue’s settings.

Cloning the queue is cheap and just increments a reference counter.

Note: A max_concurrency of 0 processes all requests instantly, effectively disabling the queue.

Implementations

impl InMemoryQueue

pub fn new( max_concurrency: u16, remaining: u32, reset_after: Duration, total: u32 ) -> Self

Creates a new InMemoryQueue with custom settings.

Panics

Panics if total < remaining.

pub fn update( &self, max_concurrency: u16, remaining: u32, reset_after: Duration, total: u32 )

Update the queue with new info from the Get Gateway Bot endpoint.

May be regularly called as the bot joins/leaves guilds.

Example

use std::time::Duration;
use twilight_http::Client;

let client = Client::new(token);
let session = client
    .gateway()
    .authed()
    .await?
    .model()
    .await?
    .session_start_limit;
queue.update(
    session.max_concurrency,
    session.remaining,
    Duration::from_millis(session.reset_after),
    session.total,
);

Panics

Panics if total < remaining.

Trait Implementations

impl Clone for InMemoryQueue

fn clone(&self) -> InMemoryQueue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InMemoryQueue

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

Formats the value using the given formatter.

impl Default for InMemoryQueue

fn default() -> Self

Creates a new InMemoryQueue with Discord’s default settings.

Currently these are:

• max_concurrency: 1
• remaining: 1000
• reset_after: LIMIT_PERIOD
• total: 1000.

impl Queue for InMemoryQueue

fn enqueue(&self, shard: u32) -> Receiver<()>

Enqueue a shard with this ID.