Enum State

pub enum State {
    Idle,
    Running,
    Terminated,
    Error,
    Offline,
}

Current state of the application.

This is a high-level state indicating what’s the status of the underlying syncs. The application starts in State::Running mode, and then hits a terminal state State::Terminated (if it gracefully exited) or State::Error (in case any of the underlying syncs ran into an error).

This can be observed with SyncService::state.

Variants

Idle

The service hasn’t ever been started yet, or has been stopped.

Running

The underlying syncs are properly running in the background.

Terminated

Any of the underlying syncs has terminated gracefully (i.e. be stopped).

Error

Any of the underlying syncs has ran into an error.

Offline

The service has entered offline mode. This state will only be entered if the SyncService has been built with the SyncServiceBuilder::with_offline_mode setting.

The SyncService will enter the offline mode if syncing with the server fails, it will then periodically check if the server is available using the /_matrix/client/versions endpoint.

Once the SyncService receives a 200 response from the /_matrix/client/versions endpoint, it will go back into the State::Running mode and attempt to sync again.

Calling SyncService::start() while in this state will abort the /_matrix/client/versions checks and attempt to sync immediately.

Calling SyncService::stop() will abort the offline mode and the SyncService will go into the State::Idle mode.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl PartialEq for State

fn eq(&self, other: &State) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for State