Enum twilight_mention::fmt::CommandMention

pub enum CommandMention {
    Command {
        id: Id<CommandMarker>,
        name: String,
    },
    SubCommand {
        id: Id<CommandMarker>,
        name: String,
        sub_command: String,
    },
    SubCommandGroup {
        id: Id<CommandMarker>,
        name: String,
        sub_command: String,
        sub_command_group: String,
    },
}

Components to construct a slash command mention.

Format slash commands, subcommands and subcommand groups. See Discord Docs/Message Formatting. See Discord Docs Changelog/Slash Command Mentions.

Variants

Command

Fields

id: Id<CommandMarker>

name: String

SubCommand

Fields

id: Id<CommandMarker>

name: String

sub_command: String

SubCommandGroup

Fields

id: Id<CommandMarker>

name: String

sub_command: String

sub_command_group: String

Implementations

impl CommandMention

pub const fn into_mention(self) -> 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

This is a self-consuming alternative to CommandMention::mention and avoids cloning.

Trait Implementations

impl Clone for CommandMention

fn clone(&self) -> CommandMention

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandMention

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

Formats the value using the given formatter.

impl Mention<CommandMention> for 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

Cloning

This implementation uses clone to construct a MentionFormat that owns the inner CommandMention as mention takes a &self. The other implementations do this for types that are Copy and therefore do not need to use clone.

To avoid cloning use CommandMention::into_mention.

fn mention(&self) -> MentionFormat<CommandMention>

Mention a resource by using its ID.

impl ParseMention for CommandMention

const SIGILS: &'static [&'static str] = _

Leading sigil(s) of the mention after the leading arrow (<).

fn parse(buf: &str) -> Result<Self, ParseMentionError<'_>>

where Self: Sized,

Parse a mention out of a buffer.

fn iter(buf: &str) -> MentionIter<'_, Self>

where Self: Sized,

Search a buffer for mentions and parse out any that are encountered.

impl PartialEq for CommandMention

fn eq(&self, other: &CommandMention) -> 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 Eq for CommandMention

impl StructuralPartialEq for CommandMention