Struct ruma_client::Client

pub struct Client<C>(_);

A client for the Matrix client-server API.

Methods

impl Client<HttpConnector<GaiResolver>>

pub fn new(homeserver_url: Url, session: Option<Session>) -> Self

Creates a new client for making HTTP requests to the given homeserver.

impl Client<HttpsConnector<HttpConnector<GaiResolver>>>

pub fn https(homeserver_url: Url, session: Option<Session>) -> Self

Creates a new client for making HTTPS requests to the given homeserver.

impl<C> Client<C> where
    C: Connect + Clone + Send + Sync + 'static, 

pub fn custom(
    hyper_client: HyperClient<C>,
    homeserver_url: Url,
    session: Option<Session>
) -> Self

Creates a new client using the given hyper::Client.

This allows the user to configure the details of HTTP as desired.

pub fn session(&self) -> Option<Session>

Get a copy of the current Session, if any.

Useful for serializing and persisting the session to be restored later.

pub async fn log_in<'_>(
    &'_ self,
    user: String,
    password: String,
    device_id: Option<DeviceId>,
    initial_device_display_name: Option<String>
) -> Result<Session, Error<Error>>

Log in with a username and password.

In contrast to api::r0::session::login::call(), this method stores the session data returned by the endpoint in this client, instead of returning it.

pub async fn register_guest<'_>(
    &'_ self
) -> Result<Session, Error<UiaaResponse>>

Register as a guest. In contrast to api::r0::account::register::call(), this method stores the session data returned by the endpoint in this client, instead of returning it.

pub async fn register_user<'_>(
    &'_ self,
    username: Option<String>,
    password: String
) -> Result<Session, Error<UiaaResponse>>

Register as a new user on this server.

In contrast to api::r0::account::register::call(), this method stores the session data returned by the endpoint in this client, instead of returning it.

The username is the local part of the returned user_id. If it is omitted from this request, the server will generate one.

pub fn sync(
    &self,
    filter: Option<Filter>,
    since: Option<String>,
    set_presence: SetPresence,
    timeout: Option<Duration>
) -> impl Stream<Item = Result<IncomingResponse, Error<Error>>> + TryStream<Ok = IncomingResponse, Error = Error<Error>>

Convenience method that represents repeated calls to the sync_events endpoint as a stream.

If the since parameter is None, the first Item might take a significant time to arrive and be deserialized, because it contains all events that have occurred in the whole lifetime of the logged-in users account and are visible to them.

pub fn request<Request: Endpoint>(
    &self,
    request: Request
) -> impl Future<Output = Result<<Request::Response as Outgoing>::Incoming, Error<Request::ResponseError>>> where
    Request::Incoming: TryFrom<Request<Vec<u8>>, Error = FromHttpRequestError>,
    <Request::Response as Outgoing>::Incoming: TryFrom<Response<Vec<u8>>, Error = FromHttpResponseError<Request::ResponseError>>, 

Makes a request to a Matrix API endpoint.

pub fn request_with_url_params<Request: Endpoint>(
    &self,
    request: Request,
    params: Option<BTreeMap<String, String>>
) -> impl Future<Output = Result<<Request::Response as Outgoing>::Incoming, Error<Request::ResponseError>>> where
    Request::Incoming: TryFrom<Request<Vec<u8>>, Error = FromHttpRequestError>,
    <Request::Response as Outgoing>::Incoming: TryFrom<Response<Vec<u8>>, Error = FromHttpResponseError<Request::ResponseError>>, 

Makes a request to a Matrix API endpoint including additional URL parameters.

Trait Implementations

impl<C> Clone for Client<C>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug> Debug for Client<C>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.