Enum ruma_common::push::PredefinedOverrideRuleId

#[non_exhaustive]
pub enum PredefinedOverrideRuleId {
    Master,
    SuppressNotices,
    InviteForMe,
    MemberEvent,
    IsUserMention,
    ContainsDisplayName,
    IsRoomMention,
    RoomNotif,
    Tombstone,
    Reaction,
    RoomServerAcl,
    SuppressEdits,
    PollResponse,
}

The rule IDs of the predefined override server push rules.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

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.

Master

.m.rule.master

SuppressNotices

.m.rule.suppress_notices

InviteForMe

.m.rule.invite_for_me

MemberEvent

.m.rule.member_event

IsUserMention

.m.rule.is_user_mention

ContainsDisplayName

👎Deprecated: Since Matrix 1.7. Use the m.mentions property with PredefinedOverrideRuleId::IsUserMention instead.

.m.rule.contains_display_name

IsRoomMention

.m.rule.is_room_mention

RoomNotif

👎Deprecated: Since Matrix 1.7. Use the m.mentions property with PredefinedOverrideRuleId::IsRoomMention instead.

.m.rule.roomnotif

Tombstone

.m.rule.tombstone

Reaction

.m.rule.reaction

RoomServerAcl

.m.rule.room.server_acl

SuppressEdits

.m.rule.suppress_edits

PollResponse

.m.rule.poll_response

This uses the unstable prefix defined in MSC3930.

Implementations

impl PredefinedOverrideRuleId

pub fn as_str(&self) -> &str

Creates a string slice from this PredefinedOverrideRuleId.

impl PredefinedOverrideRuleId

pub fn kind(&self) -> RuleKind

Get the kind of this PredefinedOverrideRuleId.

Trait Implementations

impl AsRef<str> for PredefinedOverrideRuleId

fn as_ref(&self) -> &str

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

impl Clone for PredefinedOverrideRuleId

fn clone(&self) -> PredefinedOverrideRuleId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PredefinedOverrideRuleId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PredefinedOverrideRuleId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PredefinedOverrideRuleId

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

Formats the value using the given formatter.

impl<T> From<T> for PredefinedOverrideRuleId

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> Self

Converts to this type from the input type.

impl Ord for PredefinedOverrideRuleId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PredefinedOverrideRuleId

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

fn partial_cmp(&self, other: &PredefinedOverrideRuleId) -> 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 PredefinedOverrideRuleId

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 PredefinedOverrideRuleId

impl StructuralPartialEq for PredefinedOverrideRuleId