Enum twilight_gateway::ConnectionStatus

pub enum ConnectionStatus {
    Connected,
    Disconnected {
        close_code: Option<u16>,
        reconnect_attempts: u8,
    },
    FatallyClosed {
        close_code: CloseCode,
    },
    Identifying,
    Resuming,
}

Current status of a shard.

Variants

Connected

Shard is connected to the gateway with an active session.

Disconnected

Fields

close_code: Option<u16>

Close code, if available.

reconnect_attempts: u8

Number of reconnection attempts that have been made.

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

The underlying connection may still be open.

FatallyClosed

Fields

close_code: CloseCode

Close code of the close message.

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 ConnectionStatus

pub const fn is_connected(&self) -> bool

Whether the shard is connected with an active session.

pub const fn is_disconnected(&self) -> bool

Whether the shard has disconnected but may reconnect in the future.

pub const fn is_fatally_closed(&self) -> bool

Whether the shard has fatally closed, such as due to an invalid token.

pub const fn is_identified(&self) -> bool

Whether the shard is identified with an active session.

true if the status is Connected or Resuming.

pub const fn is_identifying(&self) -> bool

Whether the shard is waiting to establish an active session.

pub const fn is_resuming(&self) -> bool

Whether the shard is replaying missed dispatch events.

The shard is considered identified whilst resuming.

Trait Implementations

impl Clone for ConnectionStatus

fn clone(&self) -> ConnectionStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionStatus

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

Formats the value using the given formatter.

impl PartialEq<ConnectionStatus> for ConnectionStatus

fn eq(&self, other: &ConnectionStatus) -> 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 Eq for ConnectionStatus

impl StructuralEq for ConnectionStatus

impl StructuralPartialEq for ConnectionStatus