Struct ruma_client::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

A Client builder.

This type can be used to construct a Client through a few method calls.

Implementations

impl ClientBuilder

pub fn homeserver_url(self, url: String) -> Self

Available on crate feature client-api only.

Set the homeserver URL.

The homeserver URL must be set before calling build() or http_client().

pub fn access_token(self, access_token: Option<String>) -> Self

Available on crate feature client-api only.

Set the access token.

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

Available on crate feature client-api only.

Set the supported Matrix versions.

This method generally shouldn’t be called. The build() or http_client() method will take care of doing a get_supported_versions request to find out about the supported versions.

pub async fn build<C>(self) -> Result<Client<C>, Error<C::Error, Error>> where
    C: DefaultConstructibleHttpClient, 

Available on crate feature client-api only.

Finish building the Client.

Uses DefaultConstructibleHttpClient::default() to create an HTTP client instance. Unless the supported Matrix versions were manually set via supported_matrix_versions, this will do a get_supported_versions request to find out about the supported versions.

pub async fn http_client<C>(
    self,
    http_client: C
) -> Result<Client<C>, Error<C::Error, Error>> where
    C: HttpClient, 

Available on crate feature client-api only.

Set the HTTP client to finish building the Client.

Unless the supported Matrix versions were manually set via supported_matrix_versions, this will do a get_supported_versions request to find out about the supported versions.