Struct ruma_client_api::r0::filter::RoomEventFilter

pub struct RoomEventFilter {
    pub not_types: Vec<String>,
    pub not_rooms: Vec<String>,
    pub limit: Option<UInt>,
    pub rooms: Option<Vec<RoomId>>,
    pub not_senders: Vec<UserId>,
    pub senders: Option<Vec<UserId>>,
    pub types: Option<Vec<String>>,
    pub contains_url: Option<bool>,
    pub lazy_load_options: LazyLoadOptions,
}

Filters to be applied to room events

Fields

not_types: Vec<String>

A list of event types to exclude.

If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed in the 'types' filter. A '*' can be used as a wildcard to match any sequence of characters.

not_rooms: Vec<String>

A list of room IDs to exclude.

If this list is absent then no rooms are excluded. A matching room will be excluded even if it is listed in the 'rooms' filter.

limit: Option<UInt>

The maximum number of events to return.

rooms: Option<Vec<RoomId>>

A list of room IDs to include.

If this list is absent then all rooms are included.

not_senders: Vec<UserId>

A list of sender IDs to exclude.

If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the 'senders' filter.

senders: Option<Vec<UserId>>

A list of senders IDs to include.

If this list is absent then all senders are included.

types: Option<Vec<String>>

A list of event types to include.

If this list is absent then all event types are included. A '*' can be used as a wildcard to match any sequence of characters.

contains_url: Option<bool>

If true include only events with a URL key in their content. If false, exclude such events.

If this item is absent then all event types are included.

lazy_load_options: LazyLoadOptions

Options to control lazy-loading of membership events.

Methods

impl RoomEventFilter

pub fn ignore_all() -> Self

A filter that can be used to ignore all room events

Trait Implementations

impl Clone for RoomEventFilter

fn clone(&self) -> RoomEventFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomEventFilter

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

Formats the value using the given formatter.

impl Default for RoomEventFilter

fn default() -> RoomEventFilter

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for RoomEventFilter

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

Deserialize this value from the given Serde deserializer.

impl Serialize for RoomEventFilter

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

Serialize this value into the given Serde serializer.