[][src]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[src]

pub fn new() -> Self[src]

Create a new default BaseClientConfig.

pub fn state_store(self, store: Box<dyn StateStore>) -> Self[src]

Set a custom implementation of a StateStore.

The state store should be opened before being set.

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

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[src]

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[src]

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[src]

impl Default for BaseClientConfig[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> AsyncTraitDeps for T where
    T: Send + Sync + Debug
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Conv for T

impl<T> Conv for T

impl<T> FmtForward for T

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pipe for T where
    T: ?Sized

impl<T> Pipe for T

impl<T> PipeAsRef for T

impl<T> PipeBorrow for T

impl<T> PipeDeref for T

impl<T> PipeRef for T

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

impl<T> Tap for T

impl<T, U> TapAsRef<U> for T where
    U: ?Sized

impl<T, U> TapBorrow<U> for T where
    U: ?Sized

impl<T> TapDeref for T

impl<T> TryConv for T

impl<T> TryConv for T

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,