Enum twilight_gateway::ShardState

pub enum ShardState {
    Active,
    Disconnected {
        reconnect_attempts: u8,
    },
    FatallyClosed,
    Identifying,
    Resuming,
}

Current state of a Shard.

Variants

Active

Shard is connected to the gateway with an active session.

Disconnected

Shard is disconnected from the gateway but may reconnect in the future.

The websocket connection may still be open.

Fields

reconnect_attempts: u8

Number of reconnection attempts that have been made.

FatallyClosed

Shard has fatally closed.

Possible reasons may be due to failed authentication, invalid intents, or other reasons. Refer to the documentation for [CloseCode] for possible reasons.

Identifying

Shard is waiting to establish or resume a session.

Resuming

Shard is replaying missed dispatch events.

The shard is considered identified whilst resuming.

Implementations

impl ShardState

pub const fn is_identified(self) -> bool

Whether the shard is identified with an active session.

true if the status is Active or Resuming.

Trait Implementations

impl Clone for ShardState

fn clone(&self) -> ShardState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShardState

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

Formats the value using the given formatter.

impl PartialEq for ShardState

fn eq(&self, other: &ShardState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ShardState

impl Eq for ShardState

impl StructuralPartialEq for ShardState