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::Error: Into<Box<dyn Error + Send + Sync>>, 

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

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 pair(
    service: T,
    bound: usize
) -> (Buffer<T, Request>, Worker<T, Request>) where
    T: Send + 'static,
    T::Error: Send + Sync,
    Request: Send + 'static, 

Creates a new Buffer wrapping service but returns the background worker.

This is useful if you do not want to spawn directly onto the tokio runtime but instead want to use your own executor. This will return the Buffer and the background Worker that you can then spawn.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Request: Debug> Debug for Buffer<T, Request> where
    T: Service<Request>,
    T::Future: Debug, 

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

Formats the value using the given formatter.

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

type Response = T::Response

Responses given by the service.

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

Errors produced by the service.

type Future = ResponseFuture<T::Future>

The future response value.

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

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

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

Process the request and return the response asynchronously.