Struct SyncServiceBuilder

pub struct SyncServiceBuilder { /* private fields */ }

Implementations

impl SyncServiceBuilder

pub fn with_cross_process_lock(self) -> Self

Enables the cross-process lock, if the sync service is being built in a multi-process setup.

It’s a prerequisite if another process can also process encryption events. This is only applicable to very specific use cases, like an external process attempting to decrypt notifications. In general, with_cross_process_lock should not be called.

Be sure to have configured Client::cross_process_store_locks_holder_name accordingly.

pub fn with_offline_mode(self) -> Self

Enable the “offline” mode for the SyncService.

To learn more about the “offline” mode read the documentation for the State::Offline enum variant.

pub fn with_share_pos(self, enable: bool) -> Self

Whether to turn SlidingSyncBuilder::share_pos on or off.

pub fn with_parent_span(self, parent_span: Span) -> Self

Set the parent tracing span to be used for the tasks within this service.

pub async fn build(self) -> Result<SyncService, Error>

Finish setting up the SyncService.

This creates the underlying sliding syncs, and will not start them in the background. The resulting SyncService must be kept alive as long as the sliding syncs are supposed to run.

Trait Implementations

impl Clone for SyncServiceBuilder

fn clone(&self) -> SyncServiceBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.