Enum twilight_model::gateway::CloseCode

#[non_exhaustive]
#[repr(u16)]pub enum CloseCode {
    UnknownError,
    UnknownOpcode,
    DecodeError,
    NotAuthenticated,
    AuthenticationFailed,
    AlreadyAuthenticated,
    InvalidSequence,
    RateLimited,
    SessionTimedOut,
    InvalidShard,
    ShardingRequired,
    InvalidApiVersion,
    InvalidIntents,
    DisallowedIntents,
}

Gateway close event codes.

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.

UnknownError

An unknown error occurred.

UnknownOpcode

An invalid opcode or payload for an opcode was sent.

DecodeError

An invalid payload was sent.

NotAuthenticated

A payload was sent prior to identifying.

AuthenticationFailed

An invalid token was sent when identifying.

AlreadyAuthenticated

Multiple identify payloads were sent.

InvalidSequence

An invalid sequence was sent for resuming.

RateLimited

Too many payloads were sent in a certain amount of time.

SessionTimedOut

The session timed out.

InvalidShard

An invalid shard was sent when identifying.

ShardingRequired

Sharding is required because there are too many guilds.

InvalidApiVersion

An invalid version for the gateway was sent.

InvalidIntents

An invalid intent was sent.

DisallowedIntents

A disallowed intent was sent, may need allowlisting.

Trait Implementations

impl Clone for CloseCode

pub fn clone(&self) -> CloseCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CloseCode

impl Debug for CloseCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CloseCode

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

Deserialize this value from the given Serde deserializer.

impl Eq for CloseCode

impl Hash for CloseCode

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 CloseCode

pub fn cmp(&self, other: &CloseCode) -> 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<CloseCode> for CloseCode

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

pub fn partial_cmp(&self, other: &CloseCode) -> 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 CloseCode

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 CloseCode

impl StructuralPartialEq for CloseCode

impl TryFrom<u16> for CloseCode

type Error = CloseCodeConversionError

The type returned in the event of a conversion error.

pub fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.