Struct List

#[non_exhaustive]
pub struct List {
    pub ranges: Vec<(UInt, UInt)>,
    pub room_details: RoomDetails,
    pub include_heroes: Option<bool>,
    pub filters: Option<ListFilters>,
}

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

A sliding sync list request (see super::Request::lists).

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.

ranges: Vec<(UInt, UInt)>

The ranges of rooms we’re interested in.

room_details: RoomDetails

The details to be included per room.

include_heroes: Option<bool>

Request a stripped variant of membership events for the users used to calculate the room name.

filters: Option<ListFilters>

Filters to apply to the list before sorting.

Trait Implementations

impl Clone for List

fn clone(&self) -> List

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for List

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

Formats the value using the given formatter.

impl Default for List

fn default() -> List

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for List

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<List> for SyncRequestList

fn from(value: List) -> SyncRequestList

Converts to this type from the input type.

impl Serialize for List

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.