Struct ruma_client_api::sync::sync_events::v5::request::ListFilters

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

Filter for a sliding sync list, set at request.

All fields are applied with AND operators, hence if is_dm is true and is_encrypted is true then only encrypted DM rooms will be returned. The absence of fields implies no filter on that criteria: it does NOT imply false.

Filters are considered sticky, meaning that the filter only has to be provided once and their parameters ‘sticks’ for future requests until a new filter overwrites them.

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

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

Same as “room_types” but inverted. 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

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<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ListFilters> for SyncRequestListFilters

fn from(value: ListFilters) -> Self

Converts to this type from the input type.

impl Serialize for ListFilters

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

where __S: Serializer,

Serialize this value into the given Serde serializer.