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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
use std::fmt;
#[cfg(all(feature = "cache", feature = "model"))]
use crate::cache::Cache;
#[cfg(all(feature = "cache", feature = "model"))]
use crate::http::CacheHttp;
#[cfg(all(feature = "cache", feature = "model"))]
use crate::internal::prelude::*;
#[cfg(all(feature = "cache", feature = "model"))]
use crate::model::id::GuildId;
use crate::model::id::{EmojiId, RoleId};
use crate::model::user::User;
use crate::model::utils::default_true;
#[cfg(all(feature = "cache", feature = "model"))]
use crate::model::ModelError;
/// Represents a custom guild emoji, which can either be created using the API, or via an
/// integration. Emojis created using the API only work within the guild it was created in.
///
/// [Discord docs](https://discord.com/developers/docs/resources/emoji#emoji-object).
#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
#[derive(Clone, Debug, Deserialize, Serialize)]
#[non_exhaustive]
pub struct Emoji {
/// Whether the emoji is animated.
#[serde(default)]
pub animated: bool,
/// Whether the emoji can be used. This may be false when the guild loses boosts, reducing the
/// emoji limit.
#[serde(default = "default_true")]
pub available: bool,
/// The Id of the emoji.
pub id: EmojiId,
/// The name of the emoji. It must be at least 2 characters long and can only contain
/// alphanumeric characters and underscores.
pub name: String,
/// Whether the emoji is managed via an [`Integration`] service.
///
/// [`Integration`]: super::Integration
#[serde(default)]
pub managed: bool,
/// Whether the emoji name needs to be surrounded by colons in order to be used by the client.
#[serde(default)]
pub require_colons: bool,
/// A list of [`Role`]s that are allowed to use the emoji. If there are no roles specified,
/// then usage is unrestricted.
///
/// [`Role`]: super::Role
#[serde(default)]
pub roles: Vec<RoleId>,
/// The user who created the emoji.
pub user: Option<User>,
}
#[cfg(feature = "model")]
impl Emoji {
/// Deletes the emoji. This method requires the cache to fetch the guild ID.
///
/// **Note**: If the emoji was created by the current user, requires either the [Create Guild
/// Expressions] or the [Manage Guild Expressions] permission. Otherwise, the [Manage Guild
/// Expressions] permission is required.
///
/// # Examples
///
/// Delete a given emoji:
///
/// ```rust,no_run
/// # use serenity::client::Context;
/// # use serenity::model::prelude::Emoji;
/// #
/// # async fn example(ctx: &Context, emoji: Emoji) -> Result<(), Box<dyn std::error::Error>> {
/// // assuming emoji has been set already
/// match emoji.delete(&ctx).await {
/// Ok(()) => println!("Emoji deleted."),
/// Err(_) => println!("Could not delete emoji."),
/// }
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission, or may return
/// [`ModelError::ItemMissing`] if the emoji is not in the cache.
///
/// [Create Guild Expressions]: crate::model::Permissions::CREATE_GUILD_EXPRESSIONS
/// [Manage Guild Expressions]: crate::model::Permissions::MANAGE_GUILD_EXPRESSIONS
#[deprecated = "Use Guild(Id)::delete_emoji, this performs a loop over all guilds!"]
#[cfg(feature = "cache")]
#[allow(deprecated)]
#[inline]
pub async fn delete(&self, cache_http: impl CacheHttp) -> Result<()> {
let guild_id = self.try_find_guild_id(&cache_http)?;
guild_id.delete_emoji(cache_http.http(), self).await
}
/// Edits the emoji by updating it with a new name. This method requires the cache to fetch the
/// guild ID.
///
/// **Note**: If the emoji was created by the current user, requires either the [Create Guild
/// Expressions] or the [Manage Guild Expressions] permission. Otherwise, the [Manage Guild
/// Expressions] permission is required.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission, or if an invalid name is
/// given.
///
/// [Create Guild Expressions]: crate::model::Permissions::CREATE_GUILD_EXPRESSIONS
/// [Manage Guild Expressions]: crate::model::Permissions::MANAGE_GUILD_EXPRESSIONS
#[deprecated = "Use Guild(Id)::edit_emoji, this performs a loop over all guilds!"]
#[cfg(feature = "cache")]
#[allow(deprecated)]
pub async fn edit(&mut self, cache_http: impl CacheHttp, name: &str) -> Result<()> {
let guild_id = self.try_find_guild_id(&cache_http)?;
*self = guild_id.edit_emoji(cache_http.http(), self.id, name).await?;
Ok(())
}
/// Finds the [`Guild`] that owns the emoji by looking through the Cache.
///
/// [`Guild`]: super::Guild
///
/// # Examples
///
/// Print the guild id that owns this emoji:
///
/// ```rust,no_run
/// # use serenity::cache::Cache;
/// # use serenity::model::guild::Emoji;
/// #
/// # fn run(cache: Cache, emoji: Emoji) {
/// // assuming emoji has been set already
/// if let Some(guild_id) = emoji.find_guild_id(&cache) {
/// println!("{} is owned by {}", emoji.name, guild_id);
/// }
/// # }
/// ```
#[deprecated = "This performs a loop over all guilds and should not be used."]
#[cfg(feature = "cache")]
#[allow(deprecated)]
#[must_use]
pub fn find_guild_id(&self, cache: impl AsRef<Cache>) -> Option<GuildId> {
for guild_entry in cache.as_ref().guilds.iter() {
let guild = guild_entry.value();
if guild.emojis.contains_key(&self.id) {
return Some(guild.id);
}
}
None
}
#[deprecated = "This performs a loop over all guilds and should not be used."]
#[cfg(feature = "cache")]
#[allow(deprecated)]
#[inline]
fn try_find_guild_id(&self, cache_http: impl CacheHttp) -> Result<GuildId> {
cache_http
.cache()
.and_then(|c| self.find_guild_id(c))
.ok_or(Error::Model(ModelError::ItemMissing))
}
/// Generates a URL to the emoji's image.
///
/// # Examples
///
/// Print the direct link to the given emoji:
///
/// ```rust,no_run
/// # use serenity::model::guild::Emoji;
/// #
/// # fn run(emoji: Emoji) {
/// // assuming emoji has been set already
/// println!("Direct link to emoji image: {}", emoji.url());
/// # }
/// ```
#[inline]
#[must_use]
pub fn url(&self) -> String {
let extension = if self.animated { "gif" } else { "png" };
cdn!("/emojis/{}.{}", self.id, extension)
}
}
impl fmt::Display for Emoji {
/// Formats the emoji into a string that will cause Discord clients to render the emoji.
///
/// This is in the format of either `<:NAME:EMOJI_ID>` for normal emojis, or
/// `<a:NAME:EMOJI_ID>` for animated emojis.
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if self.animated {
f.write_str("<a:")?;
} else {
f.write_str("<:")?;
}
f.write_str(&self.name)?;
fmt::Write::write_char(f, ':')?;
fmt::Display::fmt(&self.id, f)?;
fmt::Write::write_char(f, '>')
}
}
impl From<Emoji> for EmojiId {
/// Gets the Id of an [`Emoji`].
fn from(emoji: Emoji) -> EmojiId {
emoji.id
}
}
impl From<&Emoji> for EmojiId {
/// Gets the Id of an [`Emoji`].
fn from(emoji: &Emoji) -> EmojiId {
emoji.id
}
}