Enum serenity::prelude::GatewayError

#[non_exhaustive]
pub enum GatewayError {
    BuildingUrl,
    Closed(Option<CloseFrame<'static>>),
    ExpectedHello,
    HeartbeatFailed,
    InvalidAuthentication,
    InvalidHandshake,
    InvalidOpCode,
    InvalidShardData,
    NoAuthentication,
    NoSessionId,
    OverloadedShard,
    ReconnectFailure,
    InvalidGatewayIntents,
    DisallowedGatewayIntents,
}

An error that occurred while attempting to deal with the gateway.

Note that - from a user standpoint - there should be no situation in which you manually handle these.

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.

BuildingUrl

There was an error building a URL.

Closed(Option<CloseFrame<'static>>)

Tuple Fields

0: Option<CloseFrame<'static>>

The connection closed, potentially uncleanly.

ExpectedHello

Expected a Hello during a handshake

HeartbeatFailed

When there was an error sending a heartbeat.

InvalidAuthentication

When invalid authentication (a bad token) was sent in the IDENTIFY.

InvalidHandshake

Expected a Ready or an InvalidateSession

InvalidOpCode

An indicator that an unknown opcode was received from the gateway.

InvalidShardData

When invalid sharding data was sent in the IDENTIFY.

Examples

Sending a shard ID of 5 when sharding with 3 total is considered invalid.

NoAuthentication

When no authentication was sent in the IDENTIFY.

NoSessionId

When a session Id was expected (for resuming), but was not present.

OverloadedShard

When a shard would have too many guilds assigned to it.

Examples

When sharding 5500 guilds on 2 shards, at least one of the shards will have over the maximum number of allowed guilds per shard.

This limit is currently 2500 guilds per shard.

ReconnectFailure

Failed to reconnect after a number of attempts.

InvalidGatewayIntents

When undocumented gateway intents are provided.

DisallowedGatewayIntents

When disallowed gatewax intents are provided.

If an connection has been established but priviliged gateway intents were provided without enabling them prior.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for Error

fn from(e: GatewayError) -> Error

Performs the conversion.