Struct twilight_gateway_queue::LargeBotQueue

pub struct LargeBotQueue { /* private fields */ }

Available on crate feature twilight-http only.

Expand description

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

Trait Implementations

impl Debug for LargeBotQueue

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

Formats the value using the given formatter. Read more

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.

Auto Trait Implementations

impl !RefUnwindSafe for LargeBotQueue

impl Send for LargeBotQueue

impl Sync for LargeBotQueue

impl Unpin for LargeBotQueue

impl !UnwindSafe for LargeBotQueue

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more