Struct ruma_common::push::Ruleset

#[non_exhaustive]
pub struct Ruleset {
    pub content: IndexSet<PatternedPushRule>,
    pub override_: IndexSet<ConditionalPushRule>,
    pub room: IndexSet<SimplePushRule>,
    pub sender: IndexSet<SimplePushRule>,
    pub underride: IndexSet<ConditionalPushRule>,
}

A push ruleset scopes a set of rules according to some criteria.

For example, some rules may only be applied for messages from a particular sender, a particular room, or by default. The push ruleset contains the entire set of scopes and rules.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct {{ .. }} syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: IndexSet<PatternedPushRule>

These rules configure behavior for (unencrypted) messages that match certain patterns.

override_: IndexSet<ConditionalPushRule>

These user-configured rules are given the highest priority.

This field is named override_ instead of override because the latter is a reserved keyword in Rust.

room: IndexSet<SimplePushRule>

These rules change the behavior of all messages for a given room.

sender: IndexSet<SimplePushRule>

These rules configure notification behavior for messages from a specific Matrix user ID.

underride: IndexSet<ConditionalPushRule>

These rules are identical to override rules, but have a lower priority than content, room and sender rules.

Implementations

impl Ruleset

pub fn server_default(user_id: &UserId) -> Self

The list of all predefined push rules.

Parameters

• user_id: the user for which to generate the default rules. Some rules depend on the user’s ID (for instance those to send notifications when they are mentioned).

impl Ruleset

pub fn new() -> Self

Creates an empty Ruleset.

pub fn iter(&self) -> RulesetIter<'_>

Creates a borrowing iterator over all push rules in this Ruleset.

For an owning iterator, use .into_iter().

pub fn add(&mut self, rule: AnyPushRule) -> bool

Adds a rule to the rule set.

Returns true if the new rule was correctly added, and false if a rule with the same rule_id is already present for this kind of rule.

pub fn get_match<T>(
    &self,
    event: &Raw<T>,
    context: &PushConditionRoomCtx
) -> Option<AnyPushRuleRef<'_>> where
    T: Serialize, 

Get the first push rule that applies to this event, if any.

Arguments

• event - The raw JSON of a room message event.
• context - The context of the message and room at the time of the event.

pub fn get_actions<T>(
    &self,
    event: &Raw<T>,
    context: &PushConditionRoomCtx
) -> &[Action] where
    T: Serialize, 

Get the push actions that apply to this event.

Returns an empty slice if no push rule applies.

Arguments

• event - The raw JSON of a room message event.
• context - The context of the message and room at the time of the event.

Trait Implementations

impl Clone for Ruleset

fn clone(&self) -> Ruleset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ruleset

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

Formats the value using the given formatter.

impl Default for Ruleset

fn default() -> Ruleset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ruleset

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

Deserialize this value from the given Serde deserializer.

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.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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.

impl IntoIterator for Ruleset

type Item = AnyPushRule

The type of the elements being iterated over.

type IntoIter = RulesetIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Ruleset

type Item = AnyPushRuleRef<'a>

The type of the elements being iterated over.

type IntoIter = RulesetIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for Ruleset

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

Serialize this value into the given Serde serializer.