Struct Client 

pub struct Client { /* private fields */ }

A blocking handle to one SIE server.

Cloning shares the runtime and the connection pool.

Implementations

impl Client

pub fn new(base_url: impl AsRef<str>) -> Result<Self>

A blocking client with default settings.

pub fn builder(base_url: impl AsRef<str>) -> ClientBuilder

Start configuring a blocking client.

pub fn api(&self) -> &Client

The async client underneath, for building requests.

pub fn base_url(&self) -> &str

The server root, always with a trailing slash.

pub fn call<'a, F, Fut, T>(&'a self, request: F) -> Result<T>

where F: FnOnce(&'a Client) -> Fut, Fut: Future<Output = Result<T>> + 'a,

Build a request from the async client and run it to completion.

The closure’s borrow is tied to this client, so a request that borrows it (the namespace accessors do) is as easy to write as one that owns its state.

pub fn block_on<Fut: Future>(&self, future: Fut) -> Fut::Output

Run any future on this client’s runtime.

Useful for futures that are not a single request, such as joining several calls.

pub fn collect<S, T>(&self, stream: S) -> Result<Vec<T>>

where S: Stream<Item = Result<T>>,

Drain a stream into a Vec, stopping at the first error.

Streaming endpoints exist so a caller can act on each chunk as it lands; when the whole result is what you want, prefer the buffered endpoint instead of this.

pub fn for_each<S, T, F>(&self, stream: S, handler: F) -> Result<()>

where S: Stream<Item = Result<T>>, F: FnMut(T) -> bool,

Consume a stream chunk by chunk, without collecting it.

The callback returns false to stop early, which closes the connection.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.