Enum ruma_common::push::AnyPushRule

#[non_exhaustive]
pub enum AnyPushRule {
    Override(ConditionalPushRule),
    Content(PatternedPushRule),
    Room(SimplePushRule),
    Sender(SimplePushRule),
    Underride(ConditionalPushRule),
}

The kinds of push rules that are available.

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(ConditionalPushRule)

Rules that override all other kinds.

Content(PatternedPushRule)

Content-specific rules.

Room(SimplePushRule)

Room-specific rules.

Sender(SimplePushRule)

Sender-specific rules.

Underride(ConditionalPushRule)

Lowest priority rules.

Implementations

impl AnyPushRule

pub fn as_ref(&self) -> AnyPushRuleRef<'_>

Convert AnyPushRule to AnyPushRuleRef.

pub fn enabled(&self) -> bool

Get the enabled flag of the push rule.

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

Get the actions of the push rule.

pub fn rule_id(&self) -> &str

Get the rule_id of the push 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 Clone for AnyPushRule

fn clone(&self) -> AnyPushRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnyPushRule

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

Formats the value using the given formatter.

impl Extend<AnyPushRule> for Ruleset

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = AnyPushRule>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.