Struct StartDehydration 

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

Available on crate feature e2e-encryption only.

Named future returned by DehydratedDevices::start.

Await it to start dehydrated devices with the default behavior, or configure it first with Self::create_new_key, Self::skip_rehydration, and Self::only_if_key_cached.

Implementations

impl<'a> StartDehydration<'a>

pub fn create_new_key(self) -> Self

Generate a fresh random pickle key on start, replacing any existing entry in Secret Storage and the local cache.

The reset is suppressed if a rehydration attempt in the same start fails, so the stored key can still recover the existing dehydrated device on another client.

pub fn skip_rehydration(self) -> Self

Skip the attempt to rehydrate the existing dehydrated device before creating the next one.

By default the existing device is rehydrated first.

pub fn only_if_key_cached(self) -> Self

Do nothing unless a pickle key is already cached locally.

Useful for an opportunistic start on a freshly opened client without forcing a Secret Storage unlock.

Trait Implementations

impl<'a> Debug for StartDehydration<'a>

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

Formats the value using the given formatter.

impl<'a> IntoFuture for StartDehydration<'a>

type Output = Result<(), DehydratedDeviceError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <StartDehydration<'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.