Struct ruma_client_api::filter::IncomingRoomFilter

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

‘Incoming’ variant of RoomFilter.

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: IncomingRoomEventFilter

The per user account data to include for rooms.

timeline: IncomingRoomEventFilter

The message and state update events to include for rooms.

ephemeral: IncomingRoomEventFilter

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

state: IncomingRoomEventFilter

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 IncomingRoomFilter

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl CanBeEmpty for IncomingRoomFilter

fn is_empty(&self) -> bool

Check whether self is empty.

impl Clone for IncomingRoomFilter

fn clone(&self) -> IncomingRoomFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingRoomFilter

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

Formats the value using the given formatter.

impl Default for IncomingRoomFilter

fn default() -> IncomingRoomFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncomingRoomFilter

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

Deserialize this value from the given Serde deserializer.

impl Serialize for IncomingRoomFilter

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

Serialize this value into the given Serde serializer.