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<String>) -> 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 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

Set the presence state

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

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

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

Arguments

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

Trait Implementations

impl Clone for SyncSettings

fn clone(&self) -> SyncSettings

Returns a copy 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.