Struct RehydratedDevice

pub struct RehydratedDevice { /* private fields */ }

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

impl RehydratedDevice

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");
}
// Get the cached dehydrated key (got it after verification/recovery)
let pickle_key = machine
    .dehydrated_devices().get_dehydrated_device_pickle_key().await?.unwrap();

// 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

impl Debug for RehydratedDevice

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

Formats the value using the given formatter.