Enum twilight_mention::parse::MentionType

#[non_exhaustive]pub enum MentionType {
    Channel(ChannelId),
    Emoji(EmojiId),
    Role(RoleId),
    User(UserId),
}

Any type of mention.

Contains variants for every possible kind of mention. Can be used with ParseMention and iterated over just like any other mention.

Examples

Parse any type of mention out of a string:

use twilight_mention::parse::{MentionType, ParseMention};
use twilight_model::id::{ChannelId, RoleId, UserId};

assert_eq!(MentionType::Channel(ChannelId(123)), MentionType::parse("<#123>")?);
assert_eq!(MentionType::Role(RoleId(123)), MentionType::parse("<@&123>")?);
assert_eq!(MentionType::User(UserId(123)), MentionType::parse("<@!123>")?);

Iterate over all types of mentions in a buffer:

use twilight_mention::parse::{MentionType, ParseMention};
use twilight_model::id::{ChannelId, EmojiId, RoleId, UserId};

let buf = "channel <#12> emoji <:name:34> role <@&56> user <@78>";

let mut iter = MentionType::iter(buf);
assert!(matches!(iter.next(), Some((MentionType::Channel(ChannelId(12)), _, _))));
assert!(matches!(iter.next(), Some((MentionType::Emoji(EmojiId(34)), _, _))));
assert!(matches!(iter.next(), Some((MentionType::Role(RoleId(56)), _, _))));
assert!(matches!(iter.next(), Some((MentionType::User(UserId(78)), _, _))));
assert!(iter.next().is_none());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Channel(ChannelId)

Channel mention.

Emoji(EmojiId)

Emoji mention.

Role(RoleId)

Role mention.

User(UserId)

User mention.

Trait Implementations

impl Clone for MentionType

pub fn clone(&self) -> MentionType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MentionType

impl Debug for MentionType

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

Formats the value using the given formatter.

impl Display for MentionType

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

Formats the value using the given formatter.

impl Eq for MentionType

impl ParseMention for MentionType

pub const SIGILS: &'static [&'static str]

Sigils for any type of mention.

Contains all of the sigils of every other type of mention.

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

Parse a mention out of a buffer.

#[must_use = "you must use the iterator to lazily parse mentions"]pub fn iter(buf: &str) -> MentionIter<'_, Self> where
    Self: Sized, 

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

impl PartialEq<MentionType> for MentionType

pub fn eq(&self, other: &MentionType) -> bool

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

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

This method tests for !=.

impl StructuralEq for MentionType

impl StructuralPartialEq for MentionType