Struct SlidingSyncList

pub struct SlidingSyncList { /* private fields */ }

Available on crate feature experimental-sliding-sync only.

Holding a specific filtered list within the concept of sliding sync.

It is OK to clone this type as much as you need: cloning it is cheap.

Implementations

impl SlidingSyncList

pub fn builder(name: impl Into<String>) -> SlidingSyncListBuilder

Create a new SlidingSyncListBuilder with the given name.

pub fn name(&self) -> &str

Get the name of the list.

pub fn set_sync_mode<M>(&self, sync_mode: M)

where M: Into<SlidingSyncMode>,

Change the sync-mode.

It is sometimes necessary to change the sync-mode of a list on-the-fly.

This will change the sync-mode but also the request generator. A new request generator is generated. Since requests are calculated based on the request generator, changing the sync-mode is equivalent to “resetting” the list. It’s actually not calling Self::reset, which means that the state is not reset purposely. The ranges and the state will be updated when the next request will be sent and a response will be received. The maximum number of rooms won’t change.

pub fn state(&self) -> SlidingSyncListLoadingState

Get the current state.

pub fn state_stream( &self, ) -> (SlidingSyncListLoadingState, impl Stream<Item = SlidingSyncListLoadingState>)

Get a stream of state updates.

If this list has been reloaded from a cache, the initial value read from the cache will be published.

There’s no guarantee of ordering between items emitted by this stream and those emitted by other streams exposed on this structure.

The first part of the returned tuple is the actual loading state, and the second part is the Stream to receive updates.

pub fn timeline_limit(&self) -> Bound

Get the timeline limit.

pub fn set_timeline_limit(&self, timeline: Bound)

Set timeline limit.

pub fn maximum_number_of_rooms(&self) -> Option<u32>

Get the maximum number of rooms. See Self::maximum_number_of_rooms to learn more.

pub fn maximum_number_of_rooms_stream(&self) -> Subscriber<Option<u32>>

Get a stream of rooms count.

If this list has been reloaded from a cache, the initial value is published too.

There’s no guarantee of ordering between items emitted by this stream and those emitted by other streams exposed on this structure.

pub fn maybe_commit_sticky(&mut self, txn_id: &TransactionId)

Commit the set of sticky parameters for this list.

Trait Implementations

impl Clone for SlidingSyncList

fn clone(&self) -> SlidingSyncList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlidingSyncList

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

Formats the value using the given formatter.