Struct SlidingSyncBuilder

pub struct SlidingSyncBuilder { /* private fields */ }

Configuration for a Sliding Sync instance.

Get a new builder with methods like crate::Client::sliding_sync, or crate::SlidingSync::builder.

Implementations

impl SlidingSyncBuilder

pub fn version(self, version: Version) -> Self

Set a specific version that will override the one from the Client.

pub fn add_list(self, list_builder: SlidingSyncListBuilder) -> Self

Add the given list to the lists.

Replace any list with the same name.

pub async fn add_cached_list(self, list: SlidingSyncListBuilder) -> Result<Self>

Enroll the list in caching, reloads it from the cache if possible, and adds it to the list of lists.

This will raise an error if there was a I/O error reading from the cache.

Replace any list with the same name.

pub fn with_all_extensions(self) -> Self

Activate e2ee, to-device-message, account data, typing and receipt extensions if not yet configured.

Will leave any extension configuration found untouched, so the order does not matter.

pub fn with_e2ee_extension(self, e2ee: E2EE) -> Self

Set the E2EE extension configuration.

pub fn without_e2ee_extension(self) -> Self

Unset the E2EE extension configuration.

pub fn with_to_device_extension(self, to_device: ToDevice) -> Self

Set the ToDevice extension configuration.

pub fn without_to_device_extension(self) -> Self

Unset the ToDevice extension configuration.

pub fn with_account_data_extension(self, account_data: AccountData) -> Self

Set the account data extension configuration.

pub fn without_account_data_extension(self) -> Self

Unset the account data extension configuration.

pub fn with_typing_extension(self, typing: Typing) -> Self

Set the Typing extension configuration.

pub fn without_typing_extension(self) -> Self

Unset the Typing extension configuration.

pub fn with_receipt_extension(self, receipt: Receipts) -> Self

Set the Receipt extension configuration.

pub fn without_receipt_extension(self) -> Self

Unset the Receipt extension configuration.

pub fn poll_timeout(self, timeout: Duration) -> Self

Sets a custom timeout duration for the sliding sync polling endpoint.

This is the maximum time to wait before the sliding sync server returns the long-polling request. If no events (or other data) become available before this time elapses, the server will a return a response with empty fields.

There’s an additional network timeout on top of that that can be configured with Self::network_timeout.

pub fn network_timeout(self, timeout: Duration) -> Self

Sets a custom network timeout for the sliding sync polling.

This is not the polling timeout that can be configured with Self::poll_timeout, but an additional timeout that will be added to the former.

pub fn share_pos(self) -> Self

Should the sliding sync instance share its sync position through storage?

In general, sliding sync instances will cache the sync position (pos field in the request) in internal memory. It can be useful, in multi-process scenarios, to save it into some shared storage so that one sliding sync instance running across two different processes can continue with the same sync position it had before being stopped.

pub async fn build(self) -> Result<SlidingSync>

Build the Sliding Sync.

If self.storage_key is Some(_), load the cached data from cold storage.

Trait Implementations

impl Clone for SlidingSyncBuilder

fn clone(&self) -> SlidingSyncBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlidingSyncBuilder

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

Formats the value using the given formatter.