Struct matrix_sdk_base::sliding_sync::http::msc4186::request::ListFilters

#[non_exhaustive]
pub struct ListFilters {
    pub is_invite: Option<bool>,
    pub not_room_types: Vec<RoomTypeFilter>,
}

Available on crate feature experimental-sliding-sync only.

A sliding sync list request filters (see List::filters).

All fields are applied with AND operators. The absence of fields implies no filter on that criteria: it does NOT imply false.

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.

is_invite: Option<bool>

Whether to return invited rooms, only joined rooms or both.

Flag which only returns rooms the user is currently invited to. If unset, both invited and joined rooms are returned. If false, no invited rooms are returned. If true, only invited rooms are returned.

not_room_types: Vec<RoomTypeFilter>

Only list rooms that are not of these create-types, or all.

This can be used to filter out spaces from the room list.

Trait Implementations

impl Clone for ListFilters

fn clone(&self) -> ListFilters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListFilters

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

Formats the value using the given formatter.

impl Default for ListFilters

fn default() -> ListFilters

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListFilters

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ListFilters> for SyncRequestListFilters

Available on crate feature unstable-msc4186 only.

fn from(value: ListFilters) -> SyncRequestListFilters

Converts to this type from the input type.

impl Serialize for ListFilters

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.