Struct DehydratedDevices

pub struct DehydratedDevices { /* private fields */ }

Struct collecting methods to create and rehydrate dehydrated devices.

Implementations

impl DehydratedDevices

pub async fn create(&self) -> Result<DehydratedDevice, DehydrationError>

Create a new DehydratedDevice which can be uploaded to the server.

pub async fn rehydrate( &self, pickle_key: &DehydratedDeviceKey, device_id: &DeviceId, device_data: Raw<DehydratedDeviceData>, ) -> Result<RehydratedDevice, DehydrationError>

Rehydrate the dehydrated device.

Once rehydrated, to-device events can be pushed into the RehydratedDevice to collect the room keys the device has received.

For more info see the example for the RehydratedDevice::receive_events() method.

Arguments

• pickle_key - The encryption key that was used to encrypt the private parts of the identity keys, and one-time keys of the device.

• device_id - The unique identifier of the device.

• device_data - The encrypted data of the device, containing the private keys of the device.

pub async fn get_dehydrated_device_pickle_key( &self, ) -> Result<Option<DehydratedDeviceKey>, DehydrationError>

Get the cached dehydrated device pickle key if any.

None if the key was not previously cached (via DehydratedDevices::save_dehydrated_device_pickle_key).

Should be used to periodically rotate the dehydrated device to avoid one-time keys exhaustion and accumulation of to_device messages.

pub async fn save_dehydrated_device_pickle_key( &self, dehydrated_device_pickle_key: &DehydratedDeviceKey, ) -> Result<(), DehydrationError>

Store the dehydrated device pickle key in the crypto store.

This is useful if the client wants to periodically rotate dehydrated devices to avoid one-time keys exhaustion and accumulated to_device problems.

pub async fn delete_dehydrated_device_pickle_key( &self, ) -> Result<(), DehydrationError>

Deletes the previously stored dehydrated device pickle key.

Trait Implementations

impl Debug for DehydratedDevices

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

Formats the value using the given formatter.