Struct matrix_sdk_common::push::SimplePushRule

#[non_exhaustive]pub struct SimplePushRule {
    pub actions: Vec<Action, Global>,
    pub default: bool,
    pub enabled: bool,
    pub rule_id: String,
}

A push rule is a single rule that states under what conditions an event should be passed onto a push gateway and how the notification should be presented.

These rules are stored on the user's homeserver. They are manually configured by the user, who can create and view them via the Client/Server API.

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

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.

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.

Trait Implementations

impl Clone for SimplePushRule

pub fn clone(&self) -> SimplePushRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SimplePushRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SimplePushRule

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

Deserialize this value from the given Serde deserializer.

impl From<AnyPushRule> for SimplePushRule

pub fn from(push_rule: AnyPushRule) -> SimplePushRule

Performs the conversion.

impl From<SimplePushRule> for AnyPushRule

pub fn from(push_rule: SimplePushRule) -> AnyPushRule

Performs the conversion.

impl From<SimplePushRuleInit> for SimplePushRule

pub fn from(init: SimplePushRuleInit) -> SimplePushRule

Performs the conversion.

impl Serialize for SimplePushRule

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.