Enum serenity::prelude::GatewayError

pub enum GatewayError {
    BuildingUrl,
    Closed(Option<CloseFrame<'static>>),
    ExpectedHello,
    HeartbeatFailed,
    InvalidAuthentication,
    InvalidHandshake,
    InvalidOpCode,
    InvalidShardData,
    NoAuthentication,
    NoSessionId,
    OverloadedShard,
    ReconnectFailure,
    // some variants omitted
}

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

BuildingUrl

There was an error building a URL.

Closed(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.

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 description(&self) -> &str

Deprecated since 1.41.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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 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.