Struct ruma_client::Client

pub struct Client<C: Connect>(_);

A client for the Matrix client-server API.

Implementations

impl Client<HttpConnector>

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>>

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

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

impl<C> Client<C>where
    C: Connect + '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 log_in(
    &self,
    user: String,
    password: String,
    device_id: Option<String>
) -> impl Future<Item = 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 fn register_guest(&self) -> impl Future<Item = Session, Error = Error>

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 fn register_user(
    &self,
    username: Option<String>,
    password: String
) -> impl Future<Item = Session, Error = Error>

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: bool
) -> impl Stream<Item = Response, 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 occured in the whole lifetime of the logged-in users account and are visible to them.

Trait Implementations

impl<C: Connect> Clone for Client<C>

fn clone(&self) -> Client<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.