1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
use std::error::Error as StdError;
use std::fmt::{Display, Formatter, Result as FmtResult};
use super::Permissions;
/// 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:
///
/// ```rust,no_run
/// # #[cfg(feature="client")]
/// # use std::error::Error;
/// #
/// # #[cfg(feature="client")]
/// # fn try_main() -> Result<(), Box<Error>> {
/// use serenity::{Client, Error};
/// use serenity::model::ModelError;
/// use std::env;
///
/// let token = env::var("DISCORD_BOT_TOKEN")?;
/// let mut client = Client::new(&token);
///
/// client.on_member_unban(|context, guild_id, user| {
/// // If the user has an even discriminator, don't re-ban them.
/// if user.discriminator % 2 == 0 {
/// return;
/// }
///
/// match guild_id.ban(user, 8) {
/// Ok(()) => {
/// // Ban successful.
/// },
/// Err(Error::Model(ModelError::DeleteMessageDaysAmount(amount))) => {
/// println!("Failed deleting {} days' worth of messages", amount);
/// },
/// Err(why) => {
/// println!("Unexpected error: {:?}", why);
/// },
/// }
/// });
/// # Ok(())
/// # }
/// #
/// # #[cfg(feature="client")]
/// # fn main() {
/// # try_main().unwrap();
/// # }
/// #
/// # #[cfg(not(feature="client"))]
/// # fn main() { }
/// ```
///
/// [`Error`]: ../enum.Error.html
/// [`Error::Model`]: ../enum.Error.html#variant.Model
/// [`GuildId::ban`]: struct.GuildId.html#method.ban
/// [`model`]: ./index.html
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub enum Error {
/// When attempting to delete below or above the minimum and maximum allowed
/// number of messages.
BulkDeleteAmount,
/// When attempting to delete a number of days' worth of messages that is
/// not allowed.
DeleteMessageDaysAmount(u8),
/// Indicates that the textual content of an embed exceeds the maximum
/// length.
EmbedTooLarge(u64),
/// An indication that a [guild][`Guild`] could not be found by
/// [Id][`GuildId`] in the [`Cache`].
///
/// [`Guild`]: ../model/struct.Guild.html
/// [`GuildId`]: ../model/struct.GuildId.html
/// [`Cache`]: ../cache/struct.Cache.html
GuildNotFound,
/// Indicates that you do not have the required permissions to perform an
/// operation.
///
/// The provided [`Permission`]s is the set of required permissions
/// required.
///
/// [`Permission`]: ../model/permissions/struct.Permissions.html
InvalidPermissions(Permissions),
/// An indicator that the [current user] can not perform an action.
///
/// [current user]: ../model/struct.CurrentUser.html
InvalidUser,
/// An indicator that an item is missing from the [`Cache`], and the action
/// can not be continued.
///
/// [`Cache`]: ../cache/struct.Cache.html
ItemMissing,
/// Indicates that a [`Message`]s content was too long and will not
/// successfully send, as the length is over 2000 codepoints, or 4000 bytes.
///
/// The number of bytes larger than the limit is provided.
///
/// [`Message`]: ../model/struct.Message.html
MessageTooLong(u64),
/// Indicates that the current user is attempting to Direct Message another
/// bot user, which is disallowed by the API.
MessagingBot,
}
impl Display for Error {
fn fmt(&self, f: &mut Formatter) -> FmtResult {
f.write_str(self.description())
}
}
impl StdError for Error {
fn description(&self) -> &str {
match *self {
Error::BulkDeleteAmount => "Too few/many messages to bulk delete",
Error::DeleteMessageDaysAmount(_) => "Invalid delete message days",
Error::EmbedTooLarge(_) => "Embed too large",
Error::GuildNotFound => "Guild not found in the cache",
Error::InvalidPermissions(_) => "Invalid permissions",
Error::InvalidUser => "The current user can not perform the action",
Error::ItemMissing => "The required item is missing from the cache",
Error::MessageTooLong(_) => "Message too large",
}
}
}
|