Struct Service 

pub struct Service<T>
where
    T: ClientImpl,
{ /* private fields */ }

Available on crate feature client only.

The service which drives a connection.

This is constructed through connect() and has to be driven by calling Service::run.

Implementations

impl<T> Service<T>

where T: ClientImpl,

pub fn handle(&self) -> &Handle

Get a handle to the service.

The returned handle can be cloned and moved freely between tasks.

pub async fn run(&mut self) -> Result<(), Error>

Run the service.

This drives the underlying connection and must be called for any requests to be processed. It is typically spawned onto a task of its own.

Unless disabled through ServiceBuilder::reconnect, a connection which is lost is re-established with an exponential backoff. Any requests which were in flight at that point are failed.

This returns once Handle::close has been called, or the connection has been lost while reconnecting is disabled.

Errors

Errors if the server states another application version, see ServiceBuilder::app_version. The service has then stopped for good, and calling this again returns immediately.

Errors right away, without connecting, if a header was passed to ServiceBuilder::header which cannot be sent.

pub async fn try_connect(&mut self) -> Result<(), Error>

Establish the connection now, returning a failure to the caller instead of scheduling a reconnect.

This lets a caller fail fast when there is nothing to connect to, such as a refused connection or a missing unix socket, rather than leaving Service::run to retry with a backoff. On success the established connection is the one Service::run goes on to drive. If a connection is already established this does nothing.

The error is not reported through ServiceBuilder::on_error. The underlying transport error is available through core::error::Error::source on the returned error.

Errors without connecting if a header was passed to ServiceBuilder::header which cannot be sent, see Error::is_invalid_header.

Trait Implementations

impl<T> Debug for Service<T>

where T: ClientImpl,

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

Formats the value using the given formatter.

impl<T> Drop for Service<T>

where T: ClientImpl,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.