Struct ruma::push::PatternedPushRule [−][src]
pub struct PatternedPushRule {
pub actions: Vec<Action, Global>,
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
actions: Vec<Action, Global>
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
Default content push rules
Matches any message whose content is unencrypted and contains the local part of the user’s Matrix ID, separated by word boundaries.
pub 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
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<PatternedPushRule, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<PatternedPushRule, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Performs the conversion.
Performs the conversion.
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub 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. Read more
type Error = MissingPatternError
type Error = MissingPatternError
The type returned in the event of a conversion error.
pub fn try_from(
push_rule: PushRule
) -> Result<PatternedPushRule, <PatternedPushRule as TryFrom<PushRule>>::Error>
pub fn try_from(
push_rule: PushRule
) -> Result<PatternedPushRule, <PatternedPushRule as TryFrom<PushRule>>::Error>
Performs the conversion.
Auto Trait Implementations
impl RefUnwindSafe for PatternedPushRule
impl Send for PatternedPushRule
impl Sync for PatternedPushRule
impl Unpin for PatternedPushRule
impl UnwindSafe for PatternedPushRule
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more