Enum Error

#[non_exhaustive]
pub enum Error {
    BulkDeleteAmount,
    DeleteMessageDaysAmount(u8),
    EmbedAmount,
    EmbedTooLarge(usize),
    GuildNotFound,
    RoleNotFound,
    MemberNotFound,
    ChannelNotFound,
    MessageAlreadyCrossposted,
    CannotCrosspostMessage,
    Hierarchy,
    InvalidPermissions {
        required: Permissions,
        present: Permissions,
    },
    InvalidUser,
    ItemMissing,
    WrongGuild,
    MessageTooLong(usize),
    MessagingBot,
    InvalidChannelType,
    NameTooShort,
    NameTooLong,
    NotAuthor,
    NoTokenSet,
    DeleteNitroSticker,
    NoStickerFileSet,
    StickerAmount,
    CannotEditVoiceMessage,
}

An error returned from the model module.

This is always wrapped within the library’s Error::Model variant.

Examples

Matching an Error with this variant would look something like the following for the GuildId::ban method, which in this example is used to re-ban all members.

use serenity::model::prelude::*;
use serenity::model::ModelError;
use serenity::prelude::*;
use serenity::Error;


#[serenity::async_trait]
#[cfg(feature = "client")]
impl EventHandler for Handler {
    async fn guild_ban_removal(&self, context: Context, guild_id: GuildId, user: User) {
        match guild_id.ban(&context, user, 8).await {
            Ok(()) => {
                // Ban successful.
            },
            Err(Error::Model(ModelError::DeleteMessageDaysAmount(amount))) => {
                println!("Failed deleting {} days' worth of messages", amount);
            },
            Err(why) => {
                println!("Unexpected error: {:?}", why);
            },
        }
    }
}

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.

BulkDeleteAmount

When attempting to delete below or above the minimum or maximum allowed number of messages.

DeleteMessageDaysAmount(u8)

When attempting to delete a number of days’ worth of messages that is not allowed.

EmbedAmount

When attempting to send a message with over 10 embeds.

EmbedTooLarge(usize)

Indicates that the textual content of an embed exceeds the maximum length.

GuildNotFound

An indication that a Guild could not be found by Id in the Cache.

RoleNotFound

An indication that a Role could not be found by Id in the Cache.

MemberNotFound

An indication that a Member could not be found by Id in the Cache.

ChannelNotFound

An indication that a Channel could not be found by Id in the Cache.

MessageAlreadyCrossposted

An indication that a Message has already been crossposted, and cannot be crossposted twice.

CannotCrosspostMessage

An indication that you cannot crosspost a Message.

For instance, you cannot crosspost a system message or a message coming from the crosspost feature.

Hierarchy

Indicates that there are hierarchy problems restricting an action.

For example, when banning a user, if the other user has a role with an equal to or higher position, then they can not be banned.

When editing a role, if the role is higher in position than the current user’s highest role, then the role can not be edited.

InvalidPermissions

Indicates that you do not have the required permissions to perform an operation.

Fields

required: Permissions

Which permissions were required for the operation

present: Permissions

Which permissions the bot had

InvalidUser

An indicator that the current user cannot perform an action.

ItemMissing

An indicator that an item is missing from the Cache, and the action can not be continued.

WrongGuild

Indicates that a member, role or channel from the wrong Guild was provided.

MessageTooLong(usize)

Indicates that a Messages content was too long and will not successfully send, as the length is over 2000 codepoints.

The number of code points larger than the limit is provided.

MessagingBot

Indicates that the current user is attempting to Direct Message another bot user, which is disallowed by the API.

InvalidChannelType

An indicator that the ChannelType cannot perform an action.

NameTooShort

Indicates that the webhook name is under the 2 characters limit.

NameTooLong

Indicates that the webhook name is over the 100 characters limit.

NotAuthor

Indicates that the bot is not author of the message. This error is returned in private/direct channels.

NoTokenSet

Indicates that the webhook token is missing.

DeleteNitroSticker

When attempting to delete a built in nitro sticker instead of a guild sticker.

NoStickerFileSet

Indicates that the sticker file is missing.

StickerAmount

When attempting to send a message with over 3 stickers.

CannotEditVoiceMessage

When attempting to edit a voice message.

Implementations

impl Error

pub const fn is_cache_err(&self) -> bool

Return true if the model error is related to an item missing in the cache.

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(e: ModelError) -> Error

Converts to this type from the input type.

impl Hash for Error

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 Error

fn eq(&self, other: &Error) -> 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 Eq for Error

impl StructuralPartialEq for Error