Struct SyncSettings 

pub struct SyncSettings { /* private fields */ }

Settings for a sync call.

Implementations

impl SyncSettings

pub fn new() -> Self

Create new default sync settings.

pub fn token(self, token: impl Into<SyncToken>) -> Self

Set the sync token.

Arguments

• token - The sync token that should be used for the sync call.

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

Set the maximum time the server can wait, in milliseconds, before responding to the sync request.

Arguments

• timeout - The time the server is allowed to wait.

pub fn throttle_sync_loop(self, value: bool) -> Self

Whether to throttle sync loops.

By default, in sync loops, sync requests are throttled and sent at most once per second, even if the server responds faster than this. This behavior can be controlled using the value parameter passed here.

This setting is only active when using one of the sync loop methods:

• crate::Client::sync(),
• crate::Client::sync_with_callback
• crate::Client::sync_with_result_callback
• crate::Client::sync_stream

pub fn ignore_timeout_on_first_sync(self, ignore: bool) -> Self

Whether to ignore the timeout the first time that the /sync endpoint is called.

If there is no new data to show, the server will wait until the end of timeout before returning a response. It can be an undesirable behavior when starting a client and informing the user that we are “catching up” while waiting for the first response.

By not setting a timeout on the first request to /sync, the homeserver should reply immediately, whether the response is empty or not.

Note that this setting is ignored when calling Client::sync_once(), because there is no loop happening.

Arguments

• ignore - Whether to ignore the timeout the first time that the /sync endpoint is called.

pub fn filter(self, filter: Filter) -> Self

Set the sync filter. It can be either the filter ID, or the definition for the filter.

Arguments

• filter - The filter configuration that should be used for the sync call.

pub fn full_state(self, full_state: bool) -> Self

Should the server return the full state from the start of the timeline.

This does nothing if no sync token is set.

Arguments

• full_state - A boolean deciding if the server should return the full state or not.

pub fn set_presence(self, presence: PresenceState) -> Self

Override the presence state for this classic /sync request.

If this is not set, the request uses the client-owned sync presence value configured with Client::set_presence. The client default is [PresenceState::Online].

PresenceState::Online - The client is marked as being online. This is the active preset and client default.

PresenceState::Offline - The client is not marked as being online.

PresenceState::Unavailable - The client is marked as being idle. This is the idle preset.

Sliding Sync requests do not use this per-request setting; they read the client-owned sync presence value directly.

Arguments

• set_presence - The PresenceState that the server should set for the client.

Trait Implementations

impl Clone for SyncSettings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyncSettings

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.

impl Default for SyncSettings

fn default() -> Self

Returns the “default value” for a type.