Struct ruma_common::push::SimplePushRule

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

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>

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: T

The ID of this rule.

This is generally the Matrix ID of the entity that it applies to.

Trait Implementations

impl<T: Clone> Clone for SimplePushRule<T>

fn clone(&self) -> SimplePushRule<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SimplePushRule<T>

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

Formats the value using the given formatter.

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

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Equivalent<SimplePushRule<T>> for str

where T: AsRef<str>,

fn equivalent(&self, key: &SimplePushRule<T>) -> bool

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

impl<T> From<NewSimplePushRule<T>> for SimplePushRule<T>

fn from(new_rule: NewSimplePushRule<T>) -> Self

Converts to this type from the input type.

impl<T> From<SimplePushRuleInit<T>> for SimplePushRule<T>

fn from(init: SimplePushRuleInit<T>) -> Self

Converts to this type from the input type.

impl<T> Hash for SimplePushRule<T>

where T: Hash,

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

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<T> PartialEq for SimplePushRule<T>

where T: PartialEq<T>,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for SimplePushRule<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for SimplePushRule<T>

where T: Eq,