Enum ruma_common::push::AnyPushRuleRef

#[non_exhaustive]
pub enum AnyPushRuleRef<'a> {
    Override(&'a ConditionalPushRule),
    Content(&'a PatternedPushRule),
    Room(&'a SimplePushRule<OwnedRoomId>),
    Sender(&'a SimplePushRule<OwnedUserId>),
    Underride(&'a ConditionalPushRule),
}

Reference to any kind of push rule.

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.

Override(&'a ConditionalPushRule)

Rules that override all other kinds.

Content(&'a PatternedPushRule)

Content-specific rules.

Room(&'a SimplePushRule<OwnedRoomId>)

Room-specific rules.

Sender(&'a SimplePushRule<OwnedUserId>)

Sender-specific rules.

Underride(&'a ConditionalPushRule)

Lowest priority rules.

Implementations

impl<'a> AnyPushRuleRef<'a>

pub fn to_owned(self) -> AnyPushRule

Convert AnyPushRuleRef to AnyPushRule by cloning the inner value.

pub fn enabled(self) -> bool

Get the enabled flag of the push rule.

pub fn actions(self) -> &'a [Action]

Get the actions of the push rule.

pub fn triggers_highlight(self) -> bool

Whether an event that matches the push rule should be highlighted.

pub fn triggers_notification(self) -> bool

Whether an event that matches the push rule should trigger a notification.

pub fn triggers_sound(self) -> Option<&'a str>

The sound that should be played when an event matches the push rule, if any.

pub fn rule_id(self) -> &'a str

Get the rule_id of the push rule.

pub fn is_server_default(self) -> bool

Whether the push rule is a server-default rule.

pub fn applies( self, event: &FlattenedJson, context: &PushConditionRoomCtx, ) -> bool

Check if the push rule applies to the event.

Arguments

• event - The flattened JSON representation of a room message event.
• context - The context of the room at the time of the event.

Trait Implementations

impl<'a> Clone for AnyPushRuleRef<'a>

fn clone(&self) -> AnyPushRuleRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AnyPushRuleRef<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for AnyPushRuleRef<'a>