Struct serenity::model::Emoji

pub struct Emoji {
    pub id: EmojiId,
    pub name: String,
    pub managed: bool,
    pub require_colons: bool,
    pub roles: Vec<RoleId>,
}

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

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.

Methods

impl Emoji

fn delete(&self) -> Result<()>

Deletes the emoji.

Note: The Manage Emojis permission is required.

Note: Only user accounts may use this method.

fn edit(&mut self, name: &str) -> Result<()>

Edits the emoji by updating it with a new name.

Note: The Manage Emojis permission is required.

Note: Only user accounts may use this method.

fn find_guild_id(&self) -> Option<GuildId>

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

fn url(&self) -> String

Generates a URL to the emoji's image.

Trait Implementations

impl Display for Emoji

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

Formats the emoji into a string that will cause Discord clients to render the emoji.

This is in the format of: <:NAME:EMOJI_ID>.

impl Mentionable for Emoji

fn mention(&self) -> String

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, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.