Struct serenity::model::misc::Mention

pub struct Mention(_);

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::misc::Mention;
let user: UserId = 1.into();
let channel: ChannelId = 2.into();
let role: RoleId = 3.into();
assert_eq!(
    "<@1> <#2> <@&3>",
    format!("{} {} {}", Mention::from(user), Mention::from(channel), Mention::from(role),),
)

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<&'_ Channel> for Mention

fn from(value: &Channel) -> Self

Performs the conversion.

impl From<&'_ ChannelCategory> for Mention

fn from(value: &ChannelCategory) -> Self

Performs the conversion.

impl From<&'_ CurrentUser> for Mention

fn from(value: &CurrentUser) -> Self

Performs the conversion.

impl From<&'_ Emoji> for Mention

fn from(value: &Emoji) -> Self

Performs the conversion.

impl From<&'_ GuildChannel> for Mention

fn from(value: &GuildChannel) -> Self

Performs the conversion.

impl From<&'_ Member> for Mention

fn from(value: &Member) -> Self

Performs the conversion.

impl From<&'_ PrivateChannel> for Mention

fn from(value: &PrivateChannel) -> Self

Performs the conversion.

impl From<&'_ Role> for Mention

fn from(value: &Role) -> Self

Performs the conversion.

impl From<&'_ User> for Mention

fn from(value: &User) -> Self

Performs the conversion.

impl From<(EmojiId, bool)> for Mention

fn from(value: (EmojiId, bool)) -> Self

Performs the conversion.

impl From<ChannelId> for Mention

fn from(value: ChannelId) -> Self

Performs the conversion.

impl From<EmojiId> for Mention

fn from(value: EmojiId) -> Self

Performs the conversion.

impl From<RoleId> for Mention

fn from(value: RoleId) -> Self

Performs the conversion.

impl From<UserId> for Mention

fn from(value: UserId) -> Self

Performs the conversion.

impl Mentionable for Mention

fn mention(&self) -> Mention

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

impl Copy for Mention