Enum serenity::gateway::ConnectionStage

#[non_exhaustive]
pub enum ConnectionStage {
    Connected,
    Connecting,
    Disconnected,
    Handshake,
    Identifying,
    Resuming,
}

Available on crate feature gateway only.

Indicates the current connection stage of a Shard.

This can be useful for knowing which shards are currently “down”/“up”.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Connected

Indicator that the Shard is normally connected and is not in, e.g., a resume phase.

Connecting

Indicator that the Shard is connecting and is in, e.g., a resume phase.

Disconnected

Indicator that the Shard is fully disconnected and is not in a reconnecting phase.

Handshake

Indicator that the Shard is currently initiating a handshake.

Identifying

Indicator that the Shard has sent an IDENTIFY packet and is awaiting a READY packet.

Resuming

Indicator that the Shard has sent a RESUME packet and is awaiting a RESUMED packet.

Implementations

impl ConnectionStage

pub fn is_connecting(self) -> bool

Whether the stage is a form of connecting.

This will return true on:

• Connecting
• Handshake
• Identifying
• Resuming

All other variants will return false.

Examples

Assert that ConnectionStage::Identifying is a connecting stage:

use serenity::gateway::ConnectionStage;

assert!(ConnectionStage::Identifying.is_connecting());

Assert that ConnectionStage::Connected is not a connecting stage:

use serenity::gateway::ConnectionStage;

assert!(!ConnectionStage::Connected.is_connecting());

Trait Implementations

impl Clone for ConnectionStage

fn clone(&self) -> ConnectionStage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionStage

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

Formats the value using the given formatter.

impl Display for ConnectionStage

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

Formats the value using the given formatter.

impl Hash for ConnectionStage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ConnectionStage

fn cmp(&self, other: &ConnectionStage) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ConnectionStage

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

fn partial_cmp(&self, other: &ConnectionStage) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ConnectionStage

impl Eq for ConnectionStage

impl StructuralPartialEq for ConnectionStage