Enum ruma::push::AnyPushRule

source ·
pub enum AnyPushRule {
    Override(ConditionalPushRule),
    Content(PatternedPushRule),
    Room(SimplePushRule<OwnedRoomId>),
    Sender(SimplePushRule<OwnedUserId>),
    Underride(ConditionalPushRule),
}
Expand description

The kinds of push rules that are available.

Variants§

§

Override(ConditionalPushRule)

Rules that override all other kinds.

§

Content(PatternedPushRule)

Content-specific rules.

§

Room(SimplePushRule<OwnedRoomId>)

Room-specific rules.

§

Sender(SimplePushRule<OwnedUserId>)

Sender-specific rules.

§

Underride(ConditionalPushRule)

Lowest priority rules.

Implementations§

source§

impl AnyPushRule

source

pub fn as_ref(&self) -> AnyPushRuleRef<'_>

Available on crate feature events only.

Convert AnyPushRule to AnyPushRuleRef.

source

pub fn enabled(&self) -> bool

Available on crate feature events only.

Get the enabled flag of the push rule.

source

pub fn actions(&self) -> &[Action]

Available on crate feature events only.

Get the actions of the push rule.

source

pub fn triggers_highlight(&self) -> bool

Available on crate feature events only.

Whether an event that matches the push rule should be highlighted.

source

pub fn triggers_notification(&self) -> bool

Available on crate feature events only.

Whether an event that matches the push rule should trigger a notification.

source

pub fn triggers_sound(&self) -> Option<&str>

Available on crate feature events only.

The sound that should be played when an event matches the push rule, if any.

source

pub fn rule_id(&self) -> &str

Available on crate feature events only.

Get the rule_id of the push rule.

source

pub fn is_server_default(&self) -> bool

Available on crate feature events only.

Whether the push rule is a server-default rule.

source

pub fn applies( &self, event: &FlattenedJson, context: &PushConditionRoomCtx ) -> bool

Available on crate feature events only.

Check if the push rule applies to the event.

§Arguments
  • event - The flattened JSON representation of a room message event.
  • context - The context of the room at the time of the event.

Trait Implementations§

source§

impl Clone for AnyPushRule

source§

fn clone(&self) -> AnyPushRule

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

impl Debug for AnyPushRule

source§

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

Formats the value using the given formatter. Read more
source§

impl From<AnyPushRule> for PushRule

source§

fn from(push_rule: AnyPushRule) -> PushRule

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

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,

§

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>).
§

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

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

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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