Struct OlmMachineBuilder 

pub struct OlmMachineBuilder { /* private fields */ }

A builder object to help creating an OlmMachine instance.

Implementations

impl OlmMachineBuilder

pub fn new(user_id: &UserId, device_id: &DeviceId) -> Self

Create a new OlmMachineBuilder which will create an OlmMachine belonging to the given user id / device id.

pub fn with_crypto_store(self, store: impl IntoCryptoStore) -> Self

Set the CryptoStore implementation that will be used to store the encryption keys.

If this is not populated before OlmMachineBuilder::build is called, a new MemoryStore will be created.

pub fn with_custom_account(self, custom_account: Option<Account>) -> Self

Set a custom vodozemac::olm::Account to be used for the identity and one-time keys of this OlmMachine. If this is not set before OlmMachineBuilder::build is called, a new default one or one from the store will be used.

If an account is provided and one already exists in the store for this UserId/DeviceId combination, an error will be raised. This is useful if one wishes to create identity keys before knowing the user/device IDs, e.g., to use the identity key as the device ID.

pub async fn build(self) -> Result<OlmMachine, CryptoStoreError>

Construct a new OlmMachine from this builder.

If a store was given via OlmMachineBuilder::with_crypto_store, and the store already contains encryption keys for the given user/device pair, those will be re-used. Otherwise new device keys will be created and stored.

Trait Implementations

impl Debug for OlmMachineBuilder

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

Formats the value using the given formatter.