Struct matrix_sdk::sliding_sync::SlidingSyncListBuilder

pub struct SlidingSyncListBuilder { /* private fields */ }

Available on crate feature experimental-sliding-sync only.

Builder for SlidingSyncList.

Implementations

impl SlidingSyncListBuilder

pub fn once_built<C>(self, callback: C) -> Self

where C: Fn(SlidingSyncList) -> SlidingSyncList + Send + Sync + 'static,

Runs a callback once the list has been built.

If the list was cached, then the cached fields won’t be available in this callback. Use the streams to get published versions of the cached fields, once they’ve been set.

pub fn sync_mode(self, value: impl Into<SlidingSyncMode>) -> Self

Which SlidingSyncMode to start this list under.

pub fn sort(self, value: Vec<String>) -> Self

Sort the room list by this.

pub fn required_state(self, value: Vec<(StateEventType, String)>) -> Self

Required states to return per room.

pub fn filters(self, value: Option<SyncRequestListFilters>) -> Self

Any filters to apply to the query.

pub fn timeline_limit(self, timeline_limit: Bound) -> Self

Set the limit of regular events to fetch for the timeline.

pub fn no_timeline_limit(self) -> Self

Reset the limit of regular events to fetch for the timeline. It is left to the server to decide how many to send back

pub fn bump_event_types(self, bump_event_types: &[TimelineEventType]) -> Self

Allowlist of event types which should be considered recent activity when sorting by_recency.

By omitting event types, clients can ensure that uninteresting events (e.g. a profile 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.

Trait Implementations

impl Clone for SlidingSyncListBuilder

fn clone(&self) -> SlidingSyncListBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlidingSyncListBuilder

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.