Struct serenity::model::guild::Emoji

#[non_exhaustive]
pub struct Emoji {
    pub animated: bool,
    pub available: bool,
    pub id: EmojiId,
    pub name: String,
    pub managed: bool,
    pub require_colons: bool,
    pub roles: Vec<RoleId>,
    pub user: Option<User>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

animated: bool

Whether the emoji is animated.

available: bool

Whether the emoji can be used. This may be false when the guild loses boosts, reducing the emoji limit.

id: EmojiId

The Id of the emoji.

name: String

The name of the emoji. It must be at least 2 characters long and can only contain alphanumeric characters and underscores.

managed: bool

Whether the emoji is managed via an Integration service.

require_colons: bool

Whether the emoji name needs to be surrounded by colons in order to be used by the client.

roles: Vec<RoleId>

A list of Roles that are allowed to use the emoji. If there are no roles specified, then usage is unrestricted.

user: Option<User>

The user who created the emoji.

Implementations

impl Emoji

pub async fn delete<T: AsRef<Cache> + AsRef<Http>>(
    &self,
    cache_http: T
) -> Result<()>

Deletes the emoji. This method requires the cache to fetch the guild ID.

Note: The Manage Emojis permission is required.

Examples

Delete a given emoji:

// assuming emoji has been set already
match emoji.delete(&ctx).await {
    Ok(()) => println!("Emoji deleted."),
    Err(_) => println!("Could not delete emoji."),
}

Errors

Returns Error::Http if the current user lacks permission, or may return ModelError::ItemMissing if the emoji is not in the cache.

pub async fn edit<T: AsRef<Cache> + AsRef<Http>>(
    &mut self,
    cache_http: T,
    name: &str
) -> Result<()>

Edits the emoji by updating it with a new name. This method requires the cache to fetch the guild ID.

Note: The Manage Emojis permission is required.

Errors

Returns Error::Http if the current user lacks permission, or if an invalid name is given.

pub async fn find_guild_id(&self, cache: impl AsRef<Cache>) -> Option<GuildId>

Finds the Guild that owns the emoji by looking through the Cache.

Examples

Print the guild id that owns this emoji:

// assuming emoji has been set already
if let Some(guild_id) = emoji.find_guild_id(&cache).await {
    println!("{} is owned by {}", emoji.name, guild_id);
}

pub fn url(&self) -> String

Generates a URL to the emoji’s image.

Examples

Print the direct link to the given emoji:

// assuming emoji has been set already
println!("Direct link to emoji image: {}", emoji.url());

Trait Implementations

impl ArgumentConvert for Emoji

Look up a Emoji.

Requires the cache feature to be enabled.

The lookup strategy is as follows (in order):

1. Lookup by ID.
2. Lookup by extracting ID from the emoji.
3. Lookup by name.

type Err = EmojiParseError

The associated error which can be returned from parsing.

fn convert<'life0, 'life1, 'async_trait>(
    ctx: &'life0 Context,
    _guild_id: Option<GuildId>,
    _channel_id: Option<ChannelId>,
    s: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Err>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Parses a string s as a command parameter of this type.

impl Clone for Emoji

fn clone(&self) -> Emoji

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Emoji

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Emoji

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Emoji

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

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.

impl From<&'_ Emoji> for Mention

fn from(value: &Emoji) -> Self

Performs the conversion.

impl<'a> From<&'a Emoji> for EmojiId

fn from(emoji: &Emoji) -> EmojiId

Gets the Id of an Emoji.

impl From<Emoji> for ReactionType

fn from(emoji: Emoji) -> ReactionType

Performs the conversion.

impl From<Emoji> for EmojiId

fn from(emoji: Emoji) -> EmojiId

Gets the Id of an Emoji.

impl Mentionable for Emoji

fn mention(&self) -> Mention

Creates a Mention that will be able to notify or create a link to the item.

impl Serialize for Emoji

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.