Struct ruma_common::push::Ruleset

#[non_exhaustive]pub struct Ruleset {
    pub content: Vec<PatternedPushRule>,
    pub override_: Vec<ConditionalPushRule>,
    pub room: Vec<PushRule>,
    pub sender: Vec<PushRule>,
    pub underride: Vec<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.

To create an instance of this type, use its Default implementation and set the fields you need.

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: Vec<PatternedPushRule>

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

override_: Vec<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: Vec<PushRule>

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

sender: Vec<PushRule>

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

underride: Vec<ConditionalPushRule>

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

Trait Implementations

impl Clone for Ruleset

fn clone(&self) -> Ruleset

Returns a copy of the value.

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