Enum serenity::Error

#[non_exhaustive]pub enum Error {
    Decode(&'static str, Value),
    Format(FormatError),
    Io(IoError),
    Json(JsonError),
    Model(ModelError),
    Num(ParseIntError),
    ExceededLimit(String, u32),
    NotInRange(&'static str, u64, u64, u64),
    Other(&'static str),
    Url(String),
    Client(ClientError),
    Gateway(GatewayError),
    Http(Box<HttpError>),
    Tungstenite(TungsteniteError),
}

A common error enum returned by most of the library’s functionality within a custom Result.

The most common error types, the ClientError and GatewayError enums, are both wrapped around this in the form of the Client and Gateway variants.

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.

Decode(&'static str, Value)

An error while decoding a payload.

Format(FormatError)

There was an error with a format.

Io(IoError)

An std::io error.

Json(JsonError)

An error from the serde_json crate.

Model(ModelError)

An error from the model module.

Num(ParseIntError)

An error occurred while parsing an integer.

ExceededLimit(String, u32)

Input exceeded a limit. Providing the input and the limit that’s not supposed to be exceeded.

This only exists for the GuildId::ban and Member::ban functions. For their cases, it’s the “reason”.

NotInRange(&'static str, u64, u64, u64)

The input is not in the specified range. Returned by GuildId::members, Guild::members and PartialGuild::members

(param_name, value, range_min, range_max)

Other(&'static str)

Some other error. This is only used for “Expected value ” errors, when a more detailed error can not be easily provided via the Error::Decode variant.

Url(String)

An error from the url crate.

Client(ClientError)

A client error.

Gateway(GatewayError)

An error from the gateway module.

Http(Box<HttpError>)

An error from the http module.

Tungstenite(TungsteniteError)

An error from the tungstenite crate.

Trait Implementations

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<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub 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: FormatError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: GatewayError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: IoError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: JsonError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: ModelError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: TungsteniteError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: HttpError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(e: ReqwestError) -> Error

Performs the conversion.

impl From<InvalidHeaderValue> for Error

fn from(e: InvalidHeaderValue) -> Error

Performs the conversion.

impl From<ParseIntError> for Error

fn from(e: ParseIntError) -> Error

Performs the conversion.