Struct Client 

pub struct Client {
    pub session: Session,
    /* private fields */
}

A logged-in JMAP client: the session and the credentials, sent only to the origin the session came from.

Fields

session: Session

Implementations

impl Client

pub async fn connect( session_url: &str, username: &str, password: &str, options: &Options, ) -> Result<Self>

Fetches the session at session_url with HTTP Basic – the address and an app password.

pub async fn connect_with_token( session_url: &str, access_token: &str, options: &Options, ) -> Result<Self>

Fetches the session at session_url with an OpenID Connect access token of kernoid with the scope urn:kernoid:data – from oidc. Renew it with Client::set_access_token before it expires.

pub fn set_access_token(&self, access_token: &str)

A new access token for this client and its clones (after oidc::refresh).

pub async fn refresh_session(&mut self) -> Result<()>

Fetches the session again (after a StateChange of the session, or to see new accounts).

pub fn origin(&self) -> &str

The origin this client talks to.

pub fn primary(&self, capability: &str) -> Result<String>

The user’s own account for a capability.

pub async fn request( &self, using: &[&str], calls: Vec<(&str, Value, &str)>, ) -> Result<Responses>

Runs method calls; the first method error fails them all.

pub async fn call( &self, using: &[&str], name: &str, arguments: Value, ) -> Result<Value>

One method call; its response.

pub async fn set( &self, using: &[&str], kind: &str, account: &str, change: Value, extra: Value, ) -> Result<Value>

<type>/set (RFC 8620, 5.3); the first refused change fails it. extra adds arguments (onDestroyRemoveChildren, onExists).

pub fn download_url( &self, account: &str, blob: &str, name: &str, kind: &str, ) -> String

The URL a blob is downloaded from (RFC 8620, 6.2).

pub async fn download( &self, account: &str, blob: &str, name: &str, kind: &str, out: &mut (dyn AsyncWrite + Unpin + Send), progress: &mut (dyn FnMut(u64, Option<u64>) + Send), ) -> Result<u64>

Downloads a blob into out; progress hears the bytes so far and the whole, if the server said it.

pub async fn download_from( &self, account: &str, blob: &str, name: &str, kind: &str, from: u64, out: &mut (dyn AsyncWrite + Unpin + Send), progress: &mut (dyn FnMut(u64, Option<u64>) + Send), ) -> Result<u64>

Downloads a blob from byte from on (an HTTP range, RFC 9110, 14) into out – to go on with a download that broke off. progress hears the bytes of the whole blob so far (from included) and its size, if the server said it. Returns the bytes written to out. A server that sends the whole blob instead of the range is an error: what is in out would be wrong.

pub async fn join( &self, account: &str, kind: &str, pieces: &[String], ) -> Result<Upload>

Joins uploaded blobs, in order, into one (Blob/upload, RFC 9404) – the way to send a large file in pieces, each of which can be sent again alone. The pieces are uploads, which the server keeps for a day.

pub async fn upload( &self, account: &str, kind: &str, content: impl AsyncRead + Send + 'static, size: u64, progress: impl FnMut(u64, u64) + Send + 'static, ) -> Result<Upload>

Uploads content of size bytes (RFC 8620, 6.1); progress hears the bytes sent so far.

pub async fn event_source( &self, ping: u64, ) -> Result<impl Stream<Item = Result<Bytes>> + Send + Unpin + use<>>

Opens the push stream (RFC 8620, 7.3) for all types, with a ping each ping seconds: its bytes as they come.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.