Enum ruma_common::events::tag::TagName

#[non_exhaustive]
pub enum TagName {
    Favorite,
    LowPriority,
    ServerNotice,
    User(UserTagName),
    // some variants omitted
}

The name of a tag.

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.

Favorite

m.favourite: The user’s favorite rooms.

These should be shown with higher precedence than other rooms.

LowPriority

m.lowpriority: These should be shown with lower precedence than others.

ServerNotice

m.server_notice: Used to identify Server Notice Rooms.

User(UserTagName)

u.*: User-defined tag

Implementations

impl TagName

pub fn display_name(&self) -> &str

Returns the display name of the tag.

That means the string after m. or u. for spec- and user-defined tag names, and the string after the last dot for custom tags. If no dot is found, returns the whole string.

Trait Implementations

impl AsRef<str> for TagName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TagName

fn clone(&self) -> TagName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TagName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TagName

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for TagName

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

Formats the value using the given formatter.

impl<T> From<T> for TagName where
    T: AsRef<str> + Into<String>, 

fn from(s: T) -> TagName

Converts to this type from the input type.

impl Ord for TagName

fn cmp(&self, other: &TagName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TagName> for TagName

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

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

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

This method tests for !=.

impl PartialOrd<TagName> for TagName

fn partial_cmp(&self, other: &TagName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TagName

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for TagName

impl StructuralEq for TagName

impl StructuralPartialEq for TagName