Struct MatrixClient

pub struct MatrixClient { /* private fields */ }

A connection to a Matrix homeserver, using the hyper crate.

Implementations

impl MatrixClient

pub fn new_from_access_token( token: &str, url: &str, hdl: &Handle, ) -> impl Future<Item = Self, Error = MatrixError>

pub fn login_password( username: &str, password: &str, url: &str, hdl: &Handle, ) -> impl Future<Item = Self, Error = MatrixError>

Log in to a Matrix homeserver with a username and password, and return a client object.

Parameters

• username: the username of the account to use (NB: not a MXID)
• password: the password of the account to use
• url: the URL of the homeserver
• hdl: Tokio reactor handle

pub fn as_register_user( &mut self, user_id: String, ) -> impl Future<Item = (), Error = MatrixError>

(for Application Services) Register a user with the given user_id.

pub fn as_new( url: String, user_id: String, as_token: String, hdl: &Handle, ) -> MatrixResult<Self>

(for Application Services) Make a new AS client.

Parameters

• url: homeserver URL
• user_id: user ID to impersonate (can be changed later, using alter_user_id)
• as_token: application service token
• hdl: Tokio reactor handle

pub fn as_alter_user_id(&mut self, user_id: String)

(for Application Services) Alter the user ID which this client is masquerading as.

pub fn get_hyper(&self) -> MatrixHyper

Convenience method that clones the MatrixClient’s underlying HTTP client. Useful if you don’t want to have to make your own HTTP client, and need one for some quick’n’dirty task.

Trait Implementations

impl Clone for MatrixClient

fn clone(&self) -> MatrixClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for MatrixClient

fn drop(&mut self)

Invalidates our access token, so we don’t have millions of devices. Also sets us as offline.

impl MatrixRequestable for MatrixClient

type Txnid = Uuid

The type of the transaction ID returned by get_txnid().

type ResponseBody = Chunk

The type of the HTTP response body.

type ResponseBodyFuture = MxClientResponseBodyFuture

The type of the future returned as a HTTP response body.

type SendRequestFuture = MxClientSendRequestFuture

The type of the future returned by send_request().

fn get_url(&self) -> Cow<'_, str>

Gets the client’s URL.

fn get_access_token(&self) -> Cow<'_, str>

Gets the client’s access token.

fn get_txnid(&mut self) -> Uuid

Gets a new transaction ID.

fn get_user_id(&self) -> Cow<'_, str>

Gets the client’s user ID.

fn is_as(&self) -> bool

Checks whether the client is an Application Service (AS).

fn send_request(&mut self, req: Request<Vec<u8>>) -> Self::SendRequestFuture

Send an arbitrary HTTP request to the Matrix homeserver.

fn typed_api_call<T>( &mut self, req: Request<Vec<u8>>, discard: bool, ) -> TypedApiResponse<T, Self::SendRequestFuture, Self::ResponseBodyFuture>

where T: DeserializeOwned + 'static,

Send an arbitrary HTTP request to the Matrix homeserver, and deserialize the JSON response to a value of type T.