Struct ruma::api::client::push::PushRule

#[non_exhaustive]
pub struct PushRule {
    pub actions: Vec<Action, Global>,
    pub default: bool,
    pub enabled: bool,
    pub rule_id: String,
    pub conditions: Option<Vec<PushCondition, Global>>,
    pub pattern: Option<String>,
}

Like SimplePushRule, but may represent any kind of push rule thanks to pattern and conditions being optional.

To create an instance of this type, use one of its From implementations.

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>

The actions to perform when this rule is matched.

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.

conditions: Option<Vec<PushCondition, Global>>

The conditions that must hold true for an event in order for a rule to be applied to an event.

A rule with no conditions always matches. Only applicable to underride and override rules.

pattern: Option<String>

The glob-style pattern to match against.

Only applicable to content rules.

Trait Implementations

impl Clone for PushRule

fn clone(&self) -> PushRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PushRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PushRule

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

Deserialize this value from the given Serde deserializer.

impl From<ConditionalPushRule> for PushRule

fn from(push_rule: ConditionalPushRule) -> PushRule

Converts to this type from the input type.

impl From<ConditionalPushRuleInit> for PushRule

fn from(init: ConditionalPushRuleInit) -> PushRule

Converts to this type from the input type.

impl From<PatternedPushRule> for PushRule

fn from(push_rule: PatternedPushRule) -> PushRule

Converts to this type from the input type.

impl From<PatternedPushRuleInit> for PushRule

fn from(init: PatternedPushRuleInit) -> PushRule

Converts to this type from the input type.

impl From<PushRule> for SimplePushRule

fn from(push_rule: PushRule) -> SimplePushRule

Converts to this type from the input type.

impl From<SimplePushRule> for PushRule

fn from(push_rule: SimplePushRule) -> PushRule

Converts to this type from the input type.

impl From<SimplePushRuleInit> for PushRule

fn from(init: SimplePushRuleInit) -> PushRule

Converts to this type from the input type.

impl Serialize for PushRule

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.

impl TryFrom<PushRule> for PatternedPushRule

type Error = MissingPatternError

The type returned in the event of a conversion error.

fn try_from(
    push_rule: PushRule
) -> Result<PatternedPushRule, <PatternedPushRule as TryFrom<PushRule>>::Error>

Performs the conversion.

impl TryFrom<PushRule> for ConditionalPushRule

type Error = MissingConditionsError

The type returned in the event of a conversion error.

fn try_from(
    push_rule: PushRule
) -> Result<ConditionalPushRule, <ConditionalPushRule as TryFrom<PushRule>>::Error>

Performs the conversion.