Struct matrix_sdk::ClientConfig

pub struct ClientConfig { /* fields omitted */ }

Configuration for the creation of the Client.

When setting the StateStore it is up to the user to open/connect the storage backend before client creation.

Example

// To pass all the request through mitmproxy set the proxy and disable SSL
// verification
let client_config = ClientConfig::new()
    .proxy("http://localhost:8080")
    .unwrap()
    .disable_ssl_verification();

Implementations

impl ClientConfig

pub fn new() -> Self

Create a new default ClientConfig.

pub fn proxy(self, proxy: &str) -> Result<Self>

Set the proxy through which all the HTTP requests should go.

Note, only HTTP proxies are supported.

Arguments

• proxy - The HTTP URL of the proxy.

Example

use matrix_sdk::ClientConfig;

let client_config = ClientConfig::new()
    .proxy("http://localhost:8080")
    .unwrap();

pub fn disable_ssl_verification(self) -> Self

Disable SSL verification for the HTTP requests.

pub fn user_agent(self, user_agent: &str) -> StdResult<Self, InvalidHeaderValue>

Set a custom HTTP user agent for the client.

pub fn store_path(self, path: impl AsRef<Path>) -> 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.

pub fn request_config(self, request_config: RequestConfig) -> Self

Set the default timeout, fail and retry behavior for all HTTP requests.

pub fn get_request_config(&self) -> &RequestConfig

Get the RequestConfig

pub fn client(self, client: Arc<dyn HttpSend>) -> Self

Specify a client to handle sending requests and receiving responses.

Any type that implements the HttpSend trait can be used to send/receive http types.

Trait Implementations

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> ClientConfig

Returns the “default value” for a type.