Struct ruma_client_api::filter::RoomEventFilter

pub struct RoomEventFilter {
    pub not_types: Vec<String>,
    pub not_rooms: Vec<OwnedRoomId>,
    pub limit: Option<UInt>,
    pub rooms: Option<Vec<OwnedRoomId>>,
    pub not_senders: Vec<OwnedUserId>,
    pub senders: Option<Vec<OwnedUserId>>,
    pub types: Option<Vec<String>>,
    pub url_filter: Option<UrlFilter>,
    pub lazy_load_options: LazyLoadOptions,
    pub unread_thread_notifications: bool,
}

Available on crate features client or server only.

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

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

A list of room IDs to include.

If this list is absent then all rooms are included.

not_senders: Vec<OwnedUserId>

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

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.

url_filter: Option<UrlFilter>

Controls whether to include events with a URL key in their content.

• None: No filtering
• Some(EventsWithUrl): Only events with a URL
• Some(EventsWithoutUrl): Only events without a URL

lazy_load_options: LazyLoadOptions

Options to control lazy-loading of membership events.

Defaults to LazyLoadOptions::Disabled.

unread_thread_notifications: bool

Whether to enable per-thread notification counts.

Only applies to the sync_events endpoint.

Implementations

impl RoomEventFilter

pub fn empty() -> Self

Creates an empty RoomEventFilter.

You can also use the Default implementation.

pub fn ignore_all() -> Self

Creates a new RoomEventFilter that can be used to ignore all room events.

pub fn with_lazy_loading() -> Self

Creates a new RoomEventFilter with room member lazy-loading enabled.

Redundant membership events are disabled.

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl CanBeEmpty for RoomEventFilter

fn is_empty(&self) -> bool

Check whether self is empty.

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.