#[non_exhaustive]
pub enum Error {
Show 25 variants
BulkDeleteAmount,
DeleteMessageDaysAmount(u8),
EmbedAmount,
EmbedTooLarge(usize),
GuildNotFound,
RoleNotFound,
MemberNotFound,
ChannelNotFound,
MessageAlreadyCrossposted,
CannotCrosspostMessage,
Hierarchy,
InvalidPermissions(Permissions),
InvalidUser,
ItemMissing,
WrongGuild,
MessageTooLong(usize),
MessagingBot,
InvalidChannelType,
NameTooShort,
NameTooLong,
NotAuthor,
NoTokenSet,
DeleteNitroSticker,
NoStickerFileSet,
StickerAmount,
}
Expand description
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 with an odd discriminator:
use serenity::model::prelude::*;
use serenity::model::ModelError;
use serenity::prelude::*;
use serenity::Error;
struct Handler;
#[serenity::async_trait]
impl EventHandler for Handler {
async fn guild_ban_removal(&self, context: Context, guild_id: GuildId, user: User) {
// If the user has an even discriminator, don't re-ban them.
if user.discriminator % 2 == 0 {
return;
}
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);
},
}
}
}
let token = std::env::var("DISCORD_BOT_TOKEN")?;
let mut client =
Client::builder(&token, GatewayIntents::default()).event_handler(Handler).await?;
client.start().await?;
Variants (Non-exhaustive)
This enum is marked as non-exhaustive
BulkDeleteAmount
When attempting to delete below or above the minimum and 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
RoleNotFound
MemberNotFound
ChannelNotFound
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(Permissions)
Indicates that you do not have the required permissions to perform an operation.
The provided Permissions
is the set of required permissions
required.
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 Message
s 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.
Implementations
sourceimpl Error
impl Error
sourcepub fn is_cache_err(&self) -> bool
pub fn is_cache_err(&self) -> bool
Return true
if the model error is related to an item missing in the
cache.
Trait Implementations
sourceimpl Error for Error
impl Error for Error
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl From<Error> for Error
impl From<Error> for Error
sourcefn from(e: ModelError) -> Error
fn from(e: ModelError) -> Error
Converts to this type from the input type.
impl Eq for Error
impl StructuralEq for Error
impl StructuralPartialEq for Error
Auto Trait Implementations
impl RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl UnwindSafe for Error
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more