Enum EnableProgress

pub enum EnableProgress {
    Starting,
    CreatingBackup,
    CreatingRecoveryKey,
    BackingUp(RoomKeyCounts),
    RoomKeyUploadError,
    Done {
        recovery_key: String,
    },
}

Available on crate feature e2e-encryption only.

Enum describing the states the Recovery::enable() method can be in.

Variants

Starting

The client is just starting the process of enabling recovery, this is the initial state.

CreatingBackup

The client is creating a new server-side key backup.

CreatingRecoveryKey

The client is creating a new recovery key and uploading all the locally cached secrets to the homeserver.

BackingUp(RoomKeyCounts)

The client is currently backing up room keys to the server-side key backup. This state may be emitted multiple times until all room keys have been backed up.

RoomKeyUploadError

The client encountered an error while trying to upload all room keys to the server-side key backup.

Not all room keys may have been backed up, the client will try to back them up again at a later point. If you’d like to wait for the backup to finish again you can use the Backups::wait_for_steady_state() method.

Done

Recovery has been successfully enabled, this is the final state.

Fields

recovery_key: String

The newly created recovery key.

Trait Implementations

impl Clone for EnableProgress

fn clone(&self) -> EnableProgress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnableProgress

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

Formats the value using the given formatter.

impl Default for EnableProgress

fn default() -> EnableProgress

Returns the “default value” for a type.

impl Drop for EnableProgress

fn drop(&mut self)

Executes the destructor for this type.

impl Zeroize for EnableProgress

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.