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

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

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Expand description

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§

§actions: Vec<Action>

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

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for PushRule

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

Formats the value using the given formatter. Read more

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. Read more

impl From<AnyPushRule> for PushRule

fn from(push_rule: AnyPushRule) -> PushRule

Converts to this type from the input type.

impl<'a> From<AnyPushRuleRef<'a>> for PushRule

fn from(push_rule: AnyPushRuleRef<'a>) -> PushRule

Converts to this type from the input type.

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 ConditionalPushRule

fn from(push_rule: PushRule) -> ConditionalPushRule

Converts to this type from the input type.

impl<T> From<SimplePushRule<T>> for PushRule
where T: Into<String>,

fn from(push_rule: SimplePushRule<T>) -> PushRule

Converts to this type from the input type.

impl<T> From<SimplePushRuleInit<T>> for PushRule
where T: Into<String>,

fn from(init: SimplePushRuleInit<T>) -> 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. Read more

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<T> TryFrom<PushRule> for SimplePushRule<T>
where T: TryFrom<String>,

type Error = <T as TryFrom<String>>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

Auto Trait Implementations§

impl Freeze for PushRule

impl RefUnwindSafe for PushRule

impl Send for PushRule

impl Sync for PushRule

impl Unpin for PushRule

impl UnwindSafe for PushRule

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

impl<T> Identity for T
where T: ?Sized,

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,