diff options
Diffstat (limited to 'src/model/guild/emoji.rs')
| -rw-r--r-- | src/model/guild/emoji.rs | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/src/model/guild/emoji.rs b/src/model/guild/emoji.rs index f2c7e91..9a8ad39 100644 --- a/src/model/guild/emoji.rs +++ b/src/model/guild/emoji.rs @@ -47,6 +47,28 @@ impl Emoji { /// **Note**: Only user accounts may use this method. /// /// [Manage Emojis]: permissions/constant.MANAGE_EMOJIS.html + /// + /// # Examples + /// + /// Delete a given emoji: + /// + /// ```rust,no_run + /// # use serenity::model::{Emoji, EmojiId}; + /// # + /// # let mut emoji = Emoji { + /// # id: EmojiId(7), + /// # name: String::from("blobface"), + /// # managed: false, + /// # require_colons: false, + /// # roles: vec![], + /// # }; + /// # + /// // assuming emoji has been set already + /// match emoji.delete() { + /// Ok(()) => println!("Emoji deleted."), + /// Err(_) => println!("Could not delete emoji.") + /// } + /// ``` #[cfg(feature="cache")] pub fn delete(&self) -> Result<()> { match self.find_guild_id() { @@ -62,6 +84,26 @@ impl Emoji { /// **Note**: Only user accounts may use this method. /// /// [Manage Emojis]: permissions/constant.MANAGE_EMOJIS.html + /// + /// # Examples + /// + /// Change the name of an emoji: + /// + /// ```rust,no_run + /// # use serenity::model::{Emoji, EmojiId}; + /// # + /// # let mut emoji = Emoji { + /// # id: EmojiId(7), + /// # name: String::from("blobface"), + /// # managed: false, + /// # require_colons: false, + /// # roles: vec![], + /// # }; + /// # + /// // assuming emoji has been set already + /// let _ = emoji.edit("blobuwu"); + /// assert_eq!(emoji.name, "blobuwu"); + /// ``` #[cfg(feature="cache")] pub fn edit(&mut self, name: &str) -> Result<()> { match self.find_guild_id() { @@ -86,6 +128,27 @@ impl Emoji { /// Finds the [`Guild`] that owns the emoji by looking through the Cache. /// /// [`Guild`]: struct.Guild.html + /// + /// # Examples + /// + /// Print the guild id that owns this emoji: + /// + /// ```rust,no_run + /// # use serenity::model::{Emoji, EmojiId}; + /// # + /// # let mut emoji = Emoji { + /// # id: EmojiId(7), + /// # name: String::from("blobface"), + /// # managed: false, + /// # require_colons: false, + /// # roles: vec![], + /// # }; + /// # + /// // assuming emoji has been set already + /// if let Some(guild_id) = emoji.find_guild_id() { + /// println!("{} is owned by {}", emoji.name, guild_id); + /// } + /// ``` #[cfg(feature="cache")] pub fn find_guild_id(&self) -> Option<GuildId> { for guild in CACHE.read().unwrap().guilds.values() { @@ -100,6 +163,25 @@ impl Emoji { } /// Generates a URL to the emoji's image. + /// + /// # Examples + /// + /// Print the direct link to the given emoji: + /// + /// ```rust,no_run + /// # use serenity::model::{Emoji, EmojiId}; + /// # + /// # let mut emoji = Emoji { + /// # id: EmojiId(7), + /// # name: String::from("blobface"), + /// # managed: false, + /// # require_colons: false, + /// # roles: vec![], + /// # }; + /// # + /// // assuming emoji has been set already + /// println!("Direct link to emoji image: {}", emoji.url()); + /// ``` #[inline] pub fn url(&self) -> String { format!(cdn!("/emojis/{}.png"), self.id) |