Enum BackupState

pub enum BackupState {
    Unknown,
    Creating,
    Enabling,
    Resuming,
    Enabled,
    Downloading,
    Disabling,
}

Available on crate feature e2e-encryption only.

The possible states of the Client’s room key backup mechanism.

A local backup instance can be created either by receiving a valid backup recovery key [1] or by having the Client create a new backup itself.

The Client can also delete and disable a currently active backup.

Backups will be enabled automatically if we receive the backup recovery key either from:

• Another device using m.secret.send[2], which usually happens after completing interactive verification.
• Secret storage[3], which is done by calling the SecretStore::import_secrets() method.

Variants

Unknown

There is no locally active backup and we don’t know whether there backup exists on the server.

The reason we don’t know whether a server-side backup exists is that we don’t get notified by the server about the creation and deletion of backups. If we want to know the current state, we need to poll the server, which is done using the Backups::fetch_exists_on_server() method.

Creating

A new backup is being created by this Client. This state will be entered if you call the Backups::create() method.

Enabling

An existing backup is being enabled for use by this Client. We will enter this state if we have received a backup recovery key.

Resuming

An existing backup will be enabled to be used by this Client after the client has been restored. This state happens every time a Client is restored after we’d previously enabled a backup.

Enabled

The backup is enabled and room keys are actively being backed up.

Downloading

Room keys are currently being downloaded. This state will only happen after an Enabling state. The Client will attempt to download all room keys from the backup before transitioning into the Enabled state.

Disabling

The backup is being disabled and deleted from the server. This state will happen when you call the Backups::disable() method. After it has been disabled, we’re going to transition into the Unknown state.

Trait Implementations

impl Clone for BackupState

fn clone(&self) -> BackupState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BackupState

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

Formats the value using the given formatter.

impl Default for BackupState

fn default() -> BackupState

Returns the “default value” for a type.

impl PartialEq for BackupState

fn eq(&self, other: &BackupState) -> 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 Copy for BackupState

impl Eq for BackupState

impl StructuralPartialEq for BackupState