Struct ruma_common::push::PatternedPushRule
source · #[non_exhaustive]pub struct PatternedPushRule {
pub actions: Vec<Action>,
pub default: bool,
pub enabled: bool,
pub rule_id: String,
pub pattern: String,
}
Expand description
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 (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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§
source§impl PatternedPushRule
impl PatternedPushRule
Default content push rules
sourcepub fn contains_user_name(user_id: &UserId) -> Self
👎Deprecated: Since Matrix 1.7. Use the m.mentions property with ConditionalPushRule::is_user_mention() instead.
pub fn contains_user_name(user_id: &UserId) -> Self
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.
source§impl PatternedPushRule
impl PatternedPushRule
sourcepub fn applies_to(
&self,
key: &str,
event: &FlattenedJson,
context: &PushConditionRoomCtx,
) -> bool
pub fn applies_to( &self, key: &str, 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§
source§impl Clone for PatternedPushRule
impl Clone for PatternedPushRule
source§fn clone(&self) -> PatternedPushRule
fn clone(&self) -> PatternedPushRule
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PatternedPushRule
impl Debug for PatternedPushRule
source§impl<'de> Deserialize<'de> for PatternedPushRule
impl<'de> Deserialize<'de> for PatternedPushRule
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Equivalent<PatternedPushRule> for str
impl Equivalent<PatternedPushRule> for str
source§fn equivalent(&self, key: &PatternedPushRule) -> bool
fn equivalent(&self, key: &PatternedPushRule) -> bool
key
and return true
if they are equal.source§impl From<NewPatternedPushRule> for PatternedPushRule
impl From<NewPatternedPushRule> for PatternedPushRule
source§fn from(new_rule: NewPatternedPushRule) -> Self
fn from(new_rule: NewPatternedPushRule) -> Self
source§impl From<PatternedPushRuleInit> for PatternedPushRule
impl From<PatternedPushRuleInit> for PatternedPushRule
source§fn from(init: PatternedPushRuleInit) -> Self
fn from(init: PatternedPushRuleInit) -> Self
source§impl Hash for PatternedPushRule
impl Hash for PatternedPushRule
source§impl PartialEq for PatternedPushRule
impl PartialEq for PatternedPushRule
source§impl Serialize for PatternedPushRule
impl Serialize for PatternedPushRule
impl Eq for PatternedPushRule
Auto Trait Implementations§
impl Freeze for PatternedPushRule
impl RefUnwindSafe for PatternedPushRule
impl Send for PatternedPushRule
impl Sync for PatternedPushRule
impl Unpin for PatternedPushRule
impl UnwindSafe for PatternedPushRule
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.