Enum CloseCode

#[non_exhaustive]
#[repr(u16)]
pub enum CloseCode {
    UnknownError = 4_000,
    UnknownOpcode = 4_001,
    DecodeError = 4_002,
    NotAuthenticated = 4_003,
    AuthenticationFailed = 4_004,
    AlreadyAuthenticated = 4_005,
    InvalidSequence = 4_007,
    RateLimited = 4_008,
    SessionTimedOut = 4_009,
    InvalidShard = 4_010,
    ShardingRequired = 4_011,
    InvalidApiVersion = 4_012,
    InvalidIntents = 4_013,
    DisallowedIntents = 4_014,
}

Gateway close event codes.

See Discord Docs/Gateway Close Event Codes for more information.

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 = 4_000

An unknown error occurred.

UnknownOpcode = 4_001

An invalid opcode or payload for an opcode was sent.

DecodeError = 4_002

An invalid payload was sent.

NotAuthenticated = 4_003

A payload was sent prior to identifying.

AuthenticationFailed = 4_004

An invalid token was sent when identifying.

AlreadyAuthenticated = 4_005

Multiple identify payloads were sent.

InvalidSequence = 4_007

An invalid sequence was sent for resuming.

RateLimited = 4_008

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

SessionTimedOut = 4_009

The session timed out.

InvalidShard = 4_010

An invalid shard was sent when identifying.

ShardingRequired = 4_011

Sharding is required because there are too many guilds.

InvalidApiVersion = 4_012

An invalid version for the gateway was sent.

InvalidIntents = 4_013

An invalid intent was sent.

DisallowedIntents = 4_014

A disallowed intent was sent, may need allowlisting.

Implementations

impl CloseCode

pub const fn can_reconnect(self) -> bool

Whether the close code is one that allows reconnection of a shard.

Some close codes are considered fatal, meaning that using the same gateway shard configuration would error. For example, the AuthenticationFailed close code occurs when the provided Discord bot token is invalid, and so attempting to reconnect with the same token would fail. On the other hand, a close code such as RateLimited occurs when too many gateway commands are sent in a short time, and so creating a new connection would succeed.

Refer to Discord Docs/Gateway Close Event Codes for more information.

Reconnectable close codes

• UnknownError
• DecodeError
• NotAuthenticated
• AlreadyAuthenticated
• InvalidSequence
• RateLimited
• SessionTimedOut

Fatal close codes

• AuthenticationFailed
• InvalidShard
• ShardingRequired
• InvalidApiVersion
• InvalidIntents
• DisallowedIntents

Trait Implementations

impl Clone for CloseCode

fn clone(&self) -> CloseCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloseCode

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CloseCode

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

Formats the value using the given formatter.

impl Hash for CloseCode

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 PartialEq for CloseCode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CloseCode

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u16> for CloseCode

type Error = CloseCodeConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for CloseCode

impl Eq for CloseCode

impl StructuralPartialEq for CloseCode