Struct harmony_rust_sdk::client::Client

pub struct Client { /* fields omitted */ }

Client implementation for Harmony.

Implementations

impl Client

pub async fn new(
    homeserver_url: Uri,
    session: Option<Session>
) -> ClientResult<Self>

Create a new Client from a homeserver Uri (URL) and an (optional) session.

If port is not specified in the URL, this will add the default port 2289 to it. If scheme is not specified, this will assume the scheme is https.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;

pub async fn request<Req: ClientRequest<Resp>, Resp, IntoReq: Into<Req>>(
    &self,
    request: IntoReq
) -> ClientResult<Resp>

Sends a request.

pub fn auth_status(&self) -> AuthStatus

Get the current auth status.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
assert!(!client.auth_status().is_authenticated());

pub fn homeserver_url(&self) -> &Uri

Get the stored homeserver URL.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
assert_eq!(&client.homeserver_url().to_string(), "https://chat.harmonyapp.io:2289/");

pub async fn begin_auth(&self) -> ClientResult<()>

Start an authentication session.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
client.begin_auth().await?;
// Do auth stuff here

pub async fn next_auth_step(
    &self,
    response: AuthStepResponse
) -> ClientResult<Option<AuthStep>>

Request the next authentication step from the server.

Returns Ok(None) if authentication was completed. Returns Ok(Some(AuthStep)) if extra step is requested from the server.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
client.begin_auth().await?;
let next_step = client.next_auth_step(AuthStepResponse::Initial).await?;
// Do more auth stuff here

pub async fn prev_auth_step(&self) -> ClientResult<AuthStep>

Go back to the previous authentication step.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
client.begin_auth().await?;
let next_step = client.next_auth_step(AuthStepResponse::Initial).await?;
let prev_step = client.prev_auth_step().await?;
// Do more auth stuff here

pub async fn auth_stream(
    &self
) -> ClientResult<impl Stream<Item = ClientResult<AuthStep>> + Send + Sync>

Begin an authentication steps stream for the current authentication session.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
client.begin_auth().await?;
let auth_steps_stream = client.auth_stream().await?;
// Do auth stuff here

pub async fn subscribe_events(
    &self,
    subscriptions: Vec<EventSource>
) -> ClientResult<(impl Stream<Item = ClientResult<Event>> + Send + Sync, impl Sink<EventSource, Error = impl Debug> + Send + Sync)>

Subscribe to events coming from specified event sources.

Example

let client = Client::new("chat.harmonyapp.io:2289".parse().unwrap(), None).await?;
// Auth here
let event_stream = client.subscribe_events(vec![EventSource::Homeserver, EventSource::Action]).await?;
// Do more auth stuff here

Trait Implementations

impl Clone for Client

pub fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.