Struct ruma_common::push::OverridePushRule

pub struct OverridePushRule(pub ConditionalPushRule);

Wrapper type to disambiguate the kind of the wrapped rule

Implementations

impl OverridePushRule

Default override push rules

pub fn master() -> Self

Matches all events, this can be enabled to turn off all push notifications other than those generated by override rules set by the user.

pub fn suppress_notices() -> Self

Matches messages with a msgtype of notice.

pub fn invite_for_me(user_id: &UserId) -> Self

Matches any invites to a new room for this user.

pub fn member_event() -> Self

Matches any m.room.member_event.

pub fn contains_display_name() -> Self

Matches any message whose content is unencrypted and contains the user's current display name in the room in which it was sent.

pub fn tombstone() -> Self

Matches any state event whose type is m.room.tombstone. This is intended to notify users of a room when it is upgraded, similar to what an @room notification would accomplish.

pub fn roomnotif() -> Self

Matches any message whose content is unencrypted and contains the text @room, signifying the whole room should be notified of the event.

Trait Implementations

impl Clone for OverridePushRule

pub fn clone(&self) -> OverridePushRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OverridePushRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OverridePushRule

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

Deserialize this value from the given Serde deserializer.

impl Eq for OverridePushRule

impl Extend<OverridePushRule> for Ruleset

pub fn extend<T: IntoIterator<Item = OverridePushRule>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Ord for OverridePushRule

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<OverridePushRule> for OverridePushRule

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<OverridePushRule> for OverridePushRule

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl RulesetMember for OverridePushRule

pub fn add_to(self, ruleset: &mut Ruleset) -> bool

impl Serialize for OverridePushRule

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

Serialize this value into the given Serde serializer.