Struct twilight_mention::fmt::MentionFormat

pub struct MentionFormat<T>(/* private fields */);

Formatter to mention a resource that implements std::fmt::Display.

Examples

Mention a Id<UserMarker>:

use twilight_mention::Mention;
use twilight_model::id::{marker::UserMarker, Id};

assert_eq!("<@123>", Id::<UserMarker>::new(123).mention().to_string());

Trait Implementations

impl<T: Clone> Clone for MentionFormat<T>

fn clone(&self) -> MentionFormat<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MentionFormat<T>

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

Formats the value using the given formatter.

impl Display for MentionFormat<CommandMention>

Mention a command. This will format as:

• </NAME:COMMAND_ID> for commands
• </NAME SUBCOMMAND:ID> for subcommands
• </NAME SUBCOMMAND_GROUP SUBCOMMAND:ID> for subcommand groups

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

Formats the value using the given formatter.

impl Display for MentionFormat<Id<ChannelMarker>>

Mention a channel. This will format as <#ID>.

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

Formats the value using the given formatter.

impl Display for MentionFormat<Id<EmojiMarker>>

Mention an emoji. This will format as <:emoji:ID>.

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

Formats the value using the given formatter.

impl Display for MentionFormat<Id<RoleMarker>>

Mention a role. This will format as <@&ID>.

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

Formats the value using the given formatter.

impl Display for MentionFormat<Id<UserMarker>>

Mention a user. This will format as <@ID>.

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

Formats the value using the given formatter.

impl Display for MentionFormat<Timestamp>

Mention a user. This will format as <t:UNIX> if a style is not specified or <t:UNIX:STYLE> if a style is specified.

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for MentionFormat<T>

fn eq(&self, other: &MentionFormat<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy> Copy for MentionFormat<T>

impl<T: Eq> Eq for MentionFormat<T>

impl<T> StructuralPartialEq for MentionFormat<T>