Struct tokio_tower::pipeline::client::Client

pub struct Client<T, E, Request> where
    T: Sink<Request> + TryStream,  { /* fields omitted */ }

This type provides an implementation of a Tower Service on top of a request-at-a-time protocol transport. In particular, it wraps a transport that implements Sink<SinkItem = Request> and Stream<Item = Response> with the necessary bookkeeping to adhere to Tower's convenient fn(Request) -> Future<Response> API.

Methods

impl<T, E, Request> Client<T, E, Request> where
    T: Sink<Request> + TryStream + Send + 'static,
    E: From<Error<T, Request>>,
    E: 'static + Send,
    Request: 'static + Send,
    T::Ok: 'static + Send, 

pub fn new(transport: T) -> Self

Construct a new Client over the given transport.

If the Client errors, the error is dropped when new is used -- use with_error_handler to handle such an error explicitly.

pub fn with_error_handler<F>(transport: T, on_service_error: F) -> Self where
    F: FnOnce(E) + Send + 'static, 

Construct a new Client over the given transport.

If the Client errors, its error is passed to on_service_error.

Trait Implementations

impl<T, E, Request> Debug for Client<T, E, Request> where
    T: Sink<Request> + TryStream, 

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

Formats the value using the given formatter.

impl<T, E, Request> Load for Client<T, E, Request> where
    T: Sink<Request> + TryStream, 

type Metric = usize

A comparable load metric. Lesser values are "preferable" to greater values.

fn load(&self) -> Self::Metric

Obtains a service's load.

impl<T, E, Request> Service<Request> for Client<T, E, Request> where
    T: Sink<Request> + TryStream,
    E: From<Error<T, Request>>,
    E: 'static + Send,
    Request: 'static + Send,
    T: 'static,
    T::Ok: 'static + Send, 

type Response = T::Ok

Responses given by the service.

type Error = E

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>

The future response value.

fn poll_ready(&mut self, cx: &mut Context) -> Poll<Result<(), E>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request) -> Self::Future

Process the request and return the response asynchronously.