Struct SyncRequestList

#[non_exhaustive]
pub struct SyncRequestList {
    pub slow_get_all_rooms: bool,
    pub ranges: Vec<(UInt, UInt)>,
    pub sort: Vec<String>,
    pub room_details: RoomDetailsConfig,
    pub include_old_rooms: Option<IncludeOldRooms>,
    pub include_heroes: Option<bool>,
    pub filters: Option<SyncRequestListFilters>,
    pub bump_event_types: Vec<TimelineEventType>,
}

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 (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.

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

The ranges of rooms we’re interested in.

sort: Vec<String>

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

room_details: RoomDetailsConfig

The details to be included per room

include_old_rooms: Option<IncludeOldRooms>

If tombstoned rooms should be returned and if so, with what information attached.

include_heroes: Option<bool>

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

Sticky.

filters: Option<SyncRequestListFilters>

Filters to apply to the list before sorting. Sticky.

bump_event_types: Vec<TimelineEventType>

An allow-list of event types which should be considered recent activity when sorting by_recency. By omitting event types from this field, clients can ensure that uninteresting events (e.g. a profil rename) do not cause a room to jump to the top of its list(s). Empty or omitted bump_event_types have no effect; all events in a room will be considered recent activity.

NB. Changes to bump_event_types will NOT cause the room list to be reordered; it will only affect the ordering of rooms due to future updates.

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 From<List> for SyncRequestList

Available on crate feature unstable-msc4186 only.

fn from(value: List) -> SyncRequestList

Converts to this type from the input type.

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.