Enum Mention

pub enum Mention {
    Channel(ChannelId),
    Role(RoleId),
    User(UserId),
}

A struct that represents some way to insert a notification, link, or emoji into a message.

Display is the primary way of utilizing a Mention, either in a format_args! type of macro or with ToString::to_string(). A Mention is created using Mentionable::mention(), or with From/Into.

Examples

use serenity::model::mention::Mention;
let user = UserId::new(1);
let channel = ChannelId::new(2);
let role = RoleId::new(3);
assert_eq!(
    "<@1> <#2> <@&3>",
    format!("{} {} {}", Mention::from(user), Mention::from(channel), Mention::from(role),),
)

Variants

Channel(ChannelId)

Role(RoleId)

User(UserId)

Trait Implementations

impl Clone for Mention

fn clone(&self) -> Mention

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mention

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

Formats the value using the given formatter.

impl Display for Mention

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

Formats the value using the given formatter.

impl From<ChannelId> for Mention

fn from(value: ChannelId) -> Self

Converts to this type from the input type.

impl From<RoleId> for Mention

fn from(value: RoleId) -> Self

Converts to this type from the input type.

impl From<UserId> for Mention

fn from(value: UserId) -> Self

Converts to this type from the input type.

impl FromStr for Mention

type Err = MentionParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> StdResult<Self, Self::Err>

Parses a string s to return a value of this type.

impl Copy for Mention