Enum BackupDownloadStrategy

pub enum BackupDownloadStrategy {
    OneShot,
    AfterDecryptionFailure,
    Manual,
}

Available on crate feature e2e-encryption only.

Settings for end-to-end encryption features.

Variants

OneShot

Automatically download all room keys from the backup when the backup recovery key has been received. The backup recovery key can be received in two ways:

1. Received as a m.secret.send to-device event, after a successful interactive verification.
2. Imported from secret storage (4S) using the SecretStore::import_secrets() method.

AfterDecryptionFailure

Attempt to download a single room key if an event fails to be decrypted.

Manual

Don’t download any room keys automatically. The user can manually download room keys using the Backups::download_room_key() methods.

This is the default option.

Trait Implementations

impl Clone for BackupDownloadStrategy

fn clone(&self) -> BackupDownloadStrategy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for BackupDownloadStrategy

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for BackupDownloadStrategy

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

Formats the value using the given formatter.

impl Default for BackupDownloadStrategy

fn default() -> BackupDownloadStrategy

Returns the “default value” for a type.

impl<UT> FfiConverter<UT> for BackupDownloadStrategy

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for BackupDownloadStrategy

type FfiType = <BackupDownloadStrategy as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for BackupDownloadStrategy

type LiftType = BackupDownloadStrategy

impl<UT> LiftReturn<UT> for BackupDownloadStrategy

type ReturnType = <BackupDownloadStrategy as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for BackupDownloadStrategy

type FfiType = <BackupDownloadStrategy as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for BackupDownloadStrategy

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for BackupDownloadStrategy

type ReturnType = <BackupDownloadStrategy as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl PartialEq for BackupDownloadStrategy

fn eq(&self, other: &BackupDownloadStrategy) -> 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<UT> TypeId<UT> for BackupDownloadStrategy

const TYPE_ID_META: MetadataBuffer = _

impl Copy for BackupDownloadStrategy

impl Eq for BackupDownloadStrategy

impl StructuralPartialEq for BackupDownloadStrategy