Struct Enable

pub struct Enable<'a> { /* private fields */ }

Available on crate feature e2e-encryption only.

Named future for the Recovery::enable() method.

Implementations

impl<'a> Enable<'a>

pub fn subscribe_to_progress( &self, ) -> impl Stream<Item = Result<EnableProgress, BroadcastStreamRecvError>>

Subscribe to updates to the recovery enabling progress.

pub fn wait_for_backups_to_upload(self) -> Self

Should the enabling of the recovery also wait for all room keys to be uploaded to the server-side key backup?

This is useful if the user is enabling recovery and the room key backup just before logging out. Otherwise the logout might finish before all room keys have been backed up and thus historic messages will fail to decrypt once the user logs back in again.

pub fn with_passphrase(self, passphrase: &'a str) -> Self

In addition to the recovery key the Recovery::enable() method returns, allow this passphrase to be used for the Recovery::recover() method.

Trait Implementations

impl<'a> Debug for Enable<'a>

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

Formats the value using the given formatter.

impl<'a> IntoFuture for Enable<'a>

type Output = Result<String, RecoveryError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <Enable<'a> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.