Struct ruma::push::PatternedPushRule

pub struct PatternedPushRule {
    pub actions: Vec<Action>,
    pub default: bool,
    pub enabled: bool,
    pub rule_id: String,
    pub pattern: String,
}

Like SimplePushRule, but with an additional pattern field.

Only applicable to content rules.

To create an instance of this type, first create a PatternedPushRuleInit and convert it via PatternedPushRule::from / .into().

Fields

actions: Vec<Action>

Actions to determine if and how a notification is delivered for events matching this rule.

default: bool

Whether this is a default rule, or has been set explicitly.

enabled: bool

Whether the push rule is enabled or not.

rule_id: String

The ID of this rule.

pattern: String

The glob-style pattern to match against.

Implementations

impl PatternedPushRule

Default content push rules

pub fn contains_user_name(user_id: &UserId) -> PatternedPushRule

👎Deprecated: Since Matrix 1.7. Use the m.mentions property with ConditionalPushRule::is_user_mention() instead.

Available on crate feature events only.

Matches any message whose content is unencrypted and contains the local part of the user’s Matrix ID, separated by word boundaries.

Since Matrix 1.7, this rule only matches if the event’s content does not contain an m.mentions property.

impl PatternedPushRule

pub fn applies_to( &self, key: &str, event: &FlattenedJson, context: &PushConditionRoomCtx, ) -> bool

Available on crate feature events only.

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 PatternedPushRule

fn clone(&self) -> PatternedPushRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PatternedPushRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PatternedPushRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Equivalent<PatternedPushRule> for str

fn equivalent(&self, key: &PatternedPushRule) -> bool

Compare self to key and return true if they are equal.

impl From<NewPatternedPushRule> for PatternedPushRule

fn from(new_rule: NewPatternedPushRule) -> PatternedPushRule

Converts to this type from the input type.

impl From<PatternedPushRule> for PushRule

fn from(push_rule: PatternedPushRule) -> PushRule

Converts to this type from the input type.

impl From<PatternedPushRuleInit> for PatternedPushRule

fn from(init: PatternedPushRuleInit) -> PatternedPushRule

Converts to this type from the input type.

impl Hash for PatternedPushRule

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PatternedPushRule

fn eq(&self, other: &PatternedPushRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PatternedPushRule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PushRule> for PatternedPushRule

type Error = MissingPatternError

The type returned in the event of a conversion error.

fn try_from( push_rule: PushRule, ) -> Result<PatternedPushRule, <PatternedPushRule as TryFrom<PushRule>>::Error>

Performs the conversion.

impl Eq for PatternedPushRule