Enum ruma_common::push::PredefinedUnderrideRuleId

#[non_exhaustive]
pub enum PredefinedUnderrideRuleId {
    Call,
    EncryptedRoomOneToOne,
    RoomOneToOne,
    Message,
    Encrypted,
    PollStartOneToOne,
    PollStart,
    PollEndOneToOne,
    PollEnd,
}

The rule IDs of the predefined underride 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.

Call

.m.rule.call

EncryptedRoomOneToOne

.m.rule.encrypted_room_one_to_one

RoomOneToOne

.m.rule.room_one_to_one

Message

.m.rule.message

Encrypted

.m.rule.encrypted

PollStartOneToOne

.m.rule.poll_start_one_to_one

This uses the unstable prefix defined in MSC3930.

PollStart

.m.rule.poll_start

This uses the unstable prefix defined in MSC3930.

PollEndOneToOne

.m.rule.poll_end_one_to_one

This uses the unstable prefix defined in MSC3930.

PollEnd

.m.rule.poll_end

This uses the unstable prefix defined in MSC3930.

Implementations

impl PredefinedUnderrideRuleId

pub fn as_str(&self) -> &str

Creates a string slice from this PredefinedUnderrideRuleId.

impl PredefinedUnderrideRuleId

pub fn kind(&self) -> RuleKind

Get the kind of this PredefinedUnderrideRuleId.

Trait Implementations

impl AsRef<str> for PredefinedUnderrideRuleId

fn as_ref(&self) -> &str

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

impl Clone for PredefinedUnderrideRuleId

fn clone(&self) -> PredefinedUnderrideRuleId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PredefinedUnderrideRuleId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PredefinedUnderrideRuleId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PredefinedUnderrideRuleId

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

Formats the value using the given formatter.

impl<T> From<T> for PredefinedUnderrideRuleId

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

fn from(s: T) -> Self

Converts to this type from the input type.

impl Ord for PredefinedUnderrideRuleId

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

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

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

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 PredefinedUnderrideRuleId

impl StructuralPartialEq for PredefinedUnderrideRuleId