Struct twilight_gateway_queue::LargeBotQueue

pub struct LargeBotQueue { /* fields omitted */ }

Queue built for single-process clusters that require identifying via Sharding for Very Large Bots.

Usage with other processes will cause inconsistencies between each process cluster's ratelimit buckets. If you use multiple processes for clusters, then refer to the module-level documentation.

Implementations

impl LargeBotQueue

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

Create a new large bot queue.

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

Trait Implementations

impl Debug for LargeBotQueue

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

Formats the value using the given formatter.

impl Queue for LargeBotQueue

pub 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.