Struct twilight_gateway_queue::LargeBotQueue

pub struct LargeBotQueue { /* private fields */ }

Available on crate feature twilight-http only.

Queue built for single-process groups of shards that require identifying via Sharding for Large Bots.

Usage with other processes will cause inconsistencies between each process’s ratelimit buckets. If using multiple processes for shard groups, then refer to the module-level documentation.

Implementations

impl LargeBotQueue

pub async fn new(buckets: usize, http: Arc<Client>) -> Self

Create a new large bot queue.

You must provide the number of buckets Discord requires your bot to connect with.

The number of buckets is provided via Discord as max_concurrency which can be fetched with Client::gateway.

Panics

Panics if retrieving the session start limints fails.

Trait Implementations

impl Debug for LargeBotQueue

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

Formats the value using the given formatter.

impl Queue for LargeBotQueue

fn request( &self, shard_id: [u64; 2] ) -> Pin<Box<dyn Future<Output = ()> + Send + '_>>

Request to be able to identify with the gateway. This will place this request behind all other requests, and the returned future will resolve once the request has been completed.