Struct tower::buffer::Buffer

pub struct Buffer<T, Request> where
    T: Service<Request>,  { /* fields omitted */ }

Adds a buffer in front of an inner service.

See crate level documentation for more details.

Methods

impl<T, Request> Buffer<T, Request> where
    T: Service<Request>,
    <T as Service<Request>>::Error: Into<Box<dyn Error + 'static + Sync + Send>>, 

pub fn new(service: T, bound: usize) -> Buffer<T, Request> where
    Request: Send + 'static,
    T: Send + 'static,
    <T as Service<Request>>::Future: Send,
    <T as Service<Request>>::Error: Send,
    <T as Service<Request>>::Error: Sync, 

Creates a new Buffer wrapping service.

bound gives the maximal number of requests that can be queued for the service before backpressure is applied to callers.

The default Tokio executor is used to run the given service, which means that this method must be called while on the Tokio runtime.

pub fn with_executor<E>(
    service: T,
    bound: usize,
    executor: &mut E
) -> Buffer<T, Request> where
    E: WorkerExecutor<T, Request>, 

Creates a new Buffer wrapping service.

executor is used to spawn a new Worker task that is dedicated to draining the buffer and dispatching the requests to the internal service.

bound gives the maximal number of requests that can be queued for the service before backpressure is applied to callers.

Trait Implementations

impl<T, Request> Clone for Buffer<T, Request> where
    T: Service<Request>, 

fn clone(&self) -> Buffer<T, Request>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, Request> Service<Request> for Buffer<T, Request> where
    T: Service<Request>,
    <T as Service<Request>>::Error: Into<Box<dyn Error + 'static + Sync + Send>>, 

type Response = <T as Service<Request>>::Response

Responses given by the service.

type Error = Box<dyn Error + 'static + Sync + Send>

Errors produced by the service.

type Future = ResponseFuture<<T as Service<Request>>::Future>

The future response value.

fn poll_ready(
    &mut self,
    cx: &mut Context
) -> Poll<Result<(), <Buffer<T, Request> as Service<Request>>::Error>>

Returns Ready when the service is able to process requests.

fn call(
    &mut self,
    request: Request
) -> <Buffer<T, Request> as Service<Request>>::Future

Process the request and return the response asynchronously.