Struct DehydratedDevice

pub struct DehydratedDevice { /* private fields */ }

A dehydrated device that can uploaded to the homeserver.

To upload the dehydrated device take a look at the DehydratedDevice::keys_for_upload() method.

Implementations

impl DehydratedDevice

pub async fn keys_for_upload( &self, initial_device_display_name: String, pickle_key: &DehydratedDeviceKey, ) -> Result<Request, DehydrationError>

Get the request to upload the dehydrated device.

Arguments

• initial_device_display_name - The human-readable name this device should have.
• pickle_key - The encryption key that should be used to encrypt the private parts of the identity keys, and one-time keys of the device.

Examples

use matrix_sdk_crypto::store::DehydratedDeviceKey;

async fn example() -> anyhow::Result<()> {
// Create a new random key
let pickle_key = DehydratedDeviceKey::new()?;

// Create the dehydrated device.
let device = machine.dehydrated_devices().create().await?;

// Create the request that should upload the device.
let request = device
    .keys_for_upload("Dehydrated device".to_owned(), &pickle_key)
    .await?;

// Save the key if you want to later one rotate the dehydrated device
machine.dehydrated_devices().save_dehydrated_device_pickle_key(&pickle_key).await.unwrap();

// Send the request out using your HTTP client.
// client.send(request).await?;

Trait Implementations

impl Debug for DehydratedDevice

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

Formats the value using the given formatter.