Struct ruma_client_api::filter::RoomFilter

#[non_exhaustive]
pub struct RoomFilter {
    pub include_leave: bool,
    pub account_data: RoomEventFilter,
    pub timeline: RoomEventFilter,
    pub ephemeral: RoomEventFilter,
    pub state: RoomEventFilter,
    pub not_rooms: Vec<OwnedRoomId>,
    pub rooms: Option<Vec<OwnedRoomId>>,
}

Filters to be applied to room data.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include_leave: bool

Include rooms that the user has left in the sync.

Defaults to false.

account_data: RoomEventFilter

The per user account data to include for rooms.

timeline: RoomEventFilter

The message and state update events to include for rooms.

ephemeral: RoomEventFilter

The events that aren’t recorded in the room history, e.g. typing and receipts, to include for rooms.

state: RoomEventFilter

The state events to include for rooms.

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. This filter is applied before the filters in ephemeral, state, timeline or account_data.

rooms: Option<Vec<OwnedRoomId>>

A list of room IDs to include.

If this list is absent then all rooms are included. This filter is applied before the filters in ephemeral, state, timeline or account_data.

Implementations

impl RoomFilter

pub fn empty() -> Self

Creates an empty RoomFilter.

You can also use the Default implementation.

pub fn ignore_all() -> Self

Creates a new RoomFilter that can be used to ignore all room events (of any type).

pub fn with_lazy_loading() -> Self

Creates a new RoomFilter 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 RoomFilter

fn is_empty(&self) -> bool

Check whether self is empty.

impl Clone for RoomFilter

fn clone(&self) -> RoomFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomFilter

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

Formats the value using the given formatter.

impl Default for RoomFilter

fn default() -> RoomFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RoomFilter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.