Struct ruma::api::client::filter::RoomFilter

pub struct RoomFilter<'a> {
    pub include_leave: bool,
    pub account_data: RoomEventFilter<'a>,
    pub timeline: RoomEventFilter<'a>,
    pub ephemeral: RoomEventFilter<'a>,
    pub state: RoomEventFilter<'a>,
    pub not_rooms: &'a [OwnedRoomId],
    pub rooms: Option<&'a [OwnedRoomId]>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Filters to be applied to room data.

Fields

include_leave: bool

Include rooms that the user has left in the sync.

Defaults to false.

account_data: RoomEventFilter<'a>

The per user account data to include for rooms.

timeline: RoomEventFilter<'a>

The message and state update events to include for rooms.

ephemeral: RoomEventFilter<'a>

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

state: RoomEventFilter<'a>

The state events to include for rooms.

not_rooms: &'a [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<&'a [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<'a> RoomFilter<'a>

pub fn empty() -> RoomFilter<'a>

Creates an empty RoomFilter.

You can also use the Default implementation.

pub fn ignore_all() -> RoomFilter<'a>

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

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl<'a> CanBeEmpty for RoomFilter<'a>

fn is_empty(&self) -> bool

Check whether self is empty.

impl<'a> Clone for RoomFilter<'a>

fn clone(&self) -> RoomFilter<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RoomFilter<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RoomFilter<'a>

fn default() -> RoomFilter<'a>

Returns the “default value” for a type.

impl<'a> Serialize for RoomFilter<'a>

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

Serialize this value into the given Serde serializer.