Enum twilight_gateway::shard::stage::Stage

#[non_exhaustive]
#[repr(u8)]pub enum Stage {
    Connected,
    Disconnected,
    Handshaking,
    Identifying,
    Resuming,
}

The current connection stage of a Shard.

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 a shard is now fully connected to the gateway.

Disconnected

Indicator that a shard is now disconnected and may or may not reconnect based on whether the connection was explicitly shutdown.

Handshaking

Indicator that a shard is now handshaking with the gateway to initiate a connection.

Identifying

Indicator that a shard is now identifying with the gateway to make a new session.

Resuming

Indicator that a shard is now resuming a session.

Trait Implementations

impl Clone for Stage

pub fn clone(&self) -> Stage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Stage

impl Debug for Stage

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

Formats the value using the given formatter.

impl Default for Stage

pub fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Stage

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Stage

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

Formats the value using the given formatter.

impl Eq for Stage

impl Hash for Stage

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Stage

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Stage> for Stage

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Stage> for Stage

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Serialize for Stage

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Stage

impl StructuralPartialEq for Stage

impl TryFrom<u8> for Stage

type Error = StageConversionError

The type returned in the event of a conversion error.

pub fn try_from(num: u8) -> Result<Self, Self::Error>

Performs the conversion.