Struct ruma::api::client::sync::sync_events::v4::SyncRequestList

pub struct SyncRequestList {
    pub slow_get_all_rooms: bool,
    pub ranges: Vec<(UInt, UInt), Global>,
    pub sort: Vec<String, Global>,
    pub required_state: Vec<(RoomEventType, String), Global>,
    pub timeline_limit: Option<UInt>,
    pub filters: Option<SyncRequestListFilters>,
}

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-msc3575 only.

Sliding Sync Request for each list.

Fields

slow_get_all_rooms: bool

Put this list into the all-rooms-mode.

Settings this to true will inform the server that, no matter how slow that might be, the clients wants all rooms the filters apply to. When operating in this mode, ranges and sort will be ignored there will be no movement operations (DELETE followed by INSERT) as the client has the entire list and can work out whatever sort order they wish. There will still be DELETE and INSERT operations when rooms are left or joined respectively. In addition, there will be an initial SYNC operation to let the client know which rooms in the rooms object were from this list.

ranges: Vec<(UInt, UInt), Global>

The ranges of rooms we’re interested in.

sort: Vec<String, Global>

The sort ordering applied to this list of rooms. Sticky.

required_state: Vec<(RoomEventType, String), Global>

Required state for each room returned. An array of event type and state key tuples. Note that elements of this array are NOT sticky so they must be specified in full when they are changed. Sticky.

timeline_limit: Option<UInt>

The maximum number of timeline events to return per room. Sticky.

filters: Option<SyncRequestListFilters>

Filters to apply to the list before sorting. Sticky.

Trait Implementations

impl Clone for SyncRequestList

fn clone(&self) -> SyncRequestList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncRequestList

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

Formats the value using the given formatter.

impl Default for SyncRequestList

fn default() -> SyncRequestList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyncRequestList

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

Deserialize this value from the given Serde deserializer.

impl Serialize for SyncRequestList

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.