Struct MockClientBuilder

pub struct MockClientBuilder { /* private fields */ }

Available on crate feature testing only.

An augmented ClientBuilder that also allows for handling session login.

Implementations

impl MockClientBuilder

pub fn new(homeserver: Option<&str>) -> Self

Create a new MockClientBuilder connected to the given homeserver, using Matrix V1.12, and which will not attempt any network retry (by default).

If no homeserver is provided, http://localhost is used as a homeserver.

pub fn no_server_versions(self) -> Self

Don’t use an initial, cached server versions list in the client.

pub fn server_versions(self, versions: Vec<MatrixVersion>) -> Self

Set the cached server versions in the client.

pub fn unlogged(self) -> Self

Doesn’t log-in a user.

Authenticated requests will fail if this is called.

pub fn registered_with_oauth(self) -> Self

The client is registered with the OAuth 2.0 API.

pub fn logged_in_with_oauth(self) -> Self

The user is already logged in with the OAuth 2.0 API.

pub fn logged_in_with_token( self, token: String, user_id: OwnedUserId, device_id: OwnedDeviceId, ) -> Self

The user is already logged in with the Matrix Auth.

pub fn on_builder<F: FnOnce(ClientBuilder) -> ClientBuilder>(self, f: F) -> Self

Apply changes to the underlying ClientBuilder.

use matrix_sdk::test_utils::client::MockClientBuilder;

MockClientBuilder::new(None)
    .on_builder(|builder| {
        // Here it's possible to modify the underlying `ClientBuilder`.
        builder
            .handle_refresh_tokens()
            .cross_process_store_locks_holder_name("hodor".to_owned())
    })
    .build()
    .await;

pub async fn build(self) -> Client

Finish building the client into the final Client instance.