Enum JoinError

#[non_exhaustive]
pub enum JoinError {
    Dropped,
    NoSender,
    NoCall,
    TimedOut,
    Driver(ConnectionError),
    Skua(Box<TrySendError<ShardRunnerMessage>>),
    Twilight(SendError),
}

Available on crate feature gateway only.

Error returned when a manager or call handler is unable to send messages over Discord’s gateway.

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.

Dropped

Request to join was dropped, cancelled, or replaced.

NoSender

No available gateway connection was provided to send voice state update messages.

NoCall

Tried to leave a Call which was not found.

TimedOut

Connection details were not received from Discord in the time given in the Call’s configuration.

This can occur if a message is lost by the Discord client between restarts, or if Discord’s gateway believes that this bot is still in the channel it attempts to join.

Users should leave the server on the gateway before re-attempting connection.

Driver(ConnectionError)

Available on crate feature driver only.

The driver failed to establish a voice connection.

Users should leave the server on the gateway before re-attempting connection.

Skua(Box<TrySendError<ShardRunnerMessage>>)

Available on crate feature skua only.

skua-specific WebSocket send error.

Twilight(SendError)

Available on crate feature twilight only.

Twilight-specific WebSocket send error when a message fails to send over websocket.

Implementations

impl JoinError

pub fn should_leave_server(&self) -> bool

Indicates whether this failure may have left (or been caused by) Discord’s gateway state being in an inconsistent state.

Failure to leave before rejoining may cause further timeouts.

pub fn should_reconnect_driver(&self) -> bool

Available on crate feature driver only.

Indicates whether this failure can be reattempted via Driver::connect with retreived connection info.

Failure to leave before rejoining may cause further timeouts.

Trait Implementations

impl Debug for JoinError

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

Formats the value using the given formatter.

impl Display for JoinError

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

Formats the value using the given formatter.

impl Error for JoinError

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

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Box<TrySendError<ShardRunnerMessage>>> for JoinError

Available on crate feature skua only.

fn from(e: Box<TrySendError<ShardRunnerMessage>>) -> Self

Converts to this type from the input type.

impl From<Error> for JoinError

Available on crate feature driver only.

fn from(e: ConnectionError) -> Self

Converts to this type from the input type.

impl From<SendError> for JoinError

Available on crate feature twilight only.

fn from(e: SendError) -> Self

Converts to this type from the input type.