pub struct Enable<'a> { /* private fields */ }
Expand description
Named future for the Recovery::enable()
method.
Implementations§
Source§impl<'a> Enable<'a>
impl<'a> Enable<'a>
Sourcepub fn subscribe_to_progress(
&self,
) -> impl Stream<Item = Result<EnableProgress, BroadcastStreamRecvError>>
pub fn subscribe_to_progress( &self, ) -> impl Stream<Item = Result<EnableProgress, BroadcastStreamRecvError>>
Subscribe to updates to the recovery enabling progress.
Sourcepub fn wait_for_backups_to_upload(self) -> Self
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.
Sourcepub fn with_passphrase(self, passphrase: &'a str) -> Self
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§
Source§impl<'a> IntoFuture for Enable<'a>
impl<'a> IntoFuture for Enable<'a>
Source§type Output = Result<String, RecoveryError>
type Output = Result<String, RecoveryError>
The output that the future will produce on completion.
Source§type IntoFuture = Pin<Box<dyn Future<Output = <Enable<'a> as IntoFuture>::Output> + Send + 'a>>
type IntoFuture = Pin<Box<dyn Future<Output = <Enable<'a> as IntoFuture>::Output> + Send + 'a>>
Which kind of future are we turning this into?
Source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
Auto Trait Implementations§
impl<'a> Freeze for Enable<'a>
impl<'a> !RefUnwindSafe for Enable<'a>
impl<'a> Send for Enable<'a>
impl<'a> Sync for Enable<'a>
impl<'a> Unpin for Enable<'a>
impl<'a> !UnwindSafe for Enable<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more