ruma_common::push

Enum PushCondition

Source
pub enum PushCondition {
    EventMatch {
        key: String,
        pattern: String,
    },
    ContainsDisplayName,
    RoomMemberCount {
        is: RoomMemberCountIs,
    },
    SenderNotificationPermission {
        key: String,
    },
    RoomVersionSupports {
        feature: RoomVersionFeature,
    },
    EventPropertyIs {
        key: String,
        value: ScalarJsonValue,
    },
    EventPropertyContains {
        key: String,
        value: ScalarJsonValue,
    },
    // some variants omitted
}
Expand description

A condition that must apply for an associated push rule’s action to be taken.

Variants§

§

EventMatch

A glob pattern match on a field of the event.

Fields

§key: String

The dot-separated path of the property of the event to match.

§pattern: String

The glob-style pattern to match against.

Patterns with no special glob characters should be treated as having asterisks prepended and appended when testing the condition.

§

ContainsDisplayName

Matches unencrypted messages where content.body contains the owner’s display name in that room.

§

RoomMemberCount

Matches the current number of members in the room.

Fields

§is: RoomMemberCountIs

The condition on the current number of members in the room.

§

SenderNotificationPermission

Takes into account the current power levels in the room, ensuring the sender of the event has high enough power to trigger the notification.

Fields

§key: String

The field in the power level event the user needs a minimum power level for.

Fields must be specified under the notifications property in the power level event’s content.

§

RoomVersionSupports

Available on crate feature unstable-msc3931 only.

Apply the rule only to rooms that support a given feature.

Fields

§feature: RoomVersionFeature

The feature the room must support for the push rule to apply.

§

EventPropertyIs

Exact value match on a property of the event.

Fields

§key: String

The dot-separated path of the property of the event to match.

§value: ScalarJsonValue

The value to match against.

§

EventPropertyContains

Exact value match on a value in an array property of the event.

Fields

§key: String

The dot-separated path of the property of the event to match.

§value: ScalarJsonValue

The value to match against.

Implementations§

Source§

impl PushCondition

Source

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

Check if this condition 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. If the power levels context is missing from it, conditions that depend on it will never apply.

Trait Implementations§

Source§

impl Clone for PushCondition

Source§

fn clone(&self) -> PushCondition

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 PushCondition

Source§

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

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

impl<'de> Deserialize<'de> for PushCondition

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PushCondition

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

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

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>).
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> ToOwned for T
where T: Clone,

Source§

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

Source§

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

Source§

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

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

Source§

fn vzip(self) -> V

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

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T