pub struct RehydratedDevice { /* private fields */ }
Expand description

A rehydraded device.

This device can now receive to-device events to decrypt and gather room keys which were sent to the dehydrated device.

Implementations§

source§

impl RehydratedDevice

source

pub async fn receive_events( &self, events: Vec<Raw<AnyToDeviceEvent>>, ) -> Result<Vec<RoomKeyInfo>, OlmError>

Feed to-device events the device was supposed to receive into the RehydratedDevice.

Most to-device events we feed into the RehydratedDevice will contain room keys, the rehydrated device will pass these room keys into our own OlmMachine which will persist them and make the room keys available for use using the usual OlmMachine::decrypt_room_event() method.

Once the homeserver returns a response without any to-device events, we can safely delete the current dehydrated device and create a new one.

§Examples
async fn get_dehydrated_device() -> Result<dehydrated_device::get_dehydrated_device::unstable::Response> {
    todo!("Download the dehydrated device");
}

async fn get_events(
    device_id: &DeviceId,
    since_token: Option<&str>
) -> Result<dehydrated_device::get_events::unstable::Response> {
    todo!("Download the to-device events of the dehydrated device");
}

// Don't use a zero key for real.
let pickle_key = [0u8; 32];

// Fetch the dehydrated device from the server.
let response = get_dehydrated_device().await?;
let device_id = response.device_id;

// Rehydrate the device.
let rehydrated = machine
    .dehydrated_devices()
    .rehydrate(&pickle_key, &device_id, response.device_data)
    .await?;

let mut since_token = None;
let mut imported_room_keys = 0;

loop {
    let response =
        get_events(&device_id, since_token).await?;

    if response.events.is_empty() {
        break;
    }

    since_token = response.next_batch.as_deref();
    imported_room_keys += rehydrated.receive_events(response.events).await?.len();
}

println!("Successfully imported {imported_room_keys} from the dehydrated device.");

Trait Implementations§

source§

impl Debug for RehydratedDevice

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,