Struct matrix_sdk_base::BaseClientConfig

pub struct BaseClientConfig { /* fields omitted */ }

Configuration for the creation of the BaseClient.

Example

let client_config = BaseClientConfig::new()
    .store_path("/home/example/matrix-sdk-client")
    .passphrase("test-passphrase".to_owned());

Implementations

impl BaseClientConfig

pub fn new() -> Self

Create a new default BaseClientConfig.

pub fn crypto_store(self, store: Box<dyn CryptoStore>) -> Self

Set a custom implementation of a CryptoStore.

The crypto store should be opened before being set.

pub fn store_path<P: AsRef<Path>>(self, path: P) -> Self

Set the path for storage.

Arguments

• path - The path where the stores should save data in. It is the callers responsibility to make sure that the path exists.

In the default configuration the client will open default implementations for the crypto store and the state store. It will use the given path to open the stores. If no path is provided no store will be opened

pub fn passphrase(self, passphrase: String) -> Self

Set the passphrase to encrypt the crypto store.

Argument

• passphrase - The passphrase that will be used to encrypt the data in the cryptostore.

This is only used if no custom cryptostore is set.

Trait Implementations

impl Debug for BaseClientConfig

fn fmt(&self, fmt: &mut Formatter<'_>) -> StdResult<(), Error>

Formats the value using the given formatter.

impl Default for BaseClientConfig

fn default() -> BaseClientConfig

Returns the “default value” for a type.