Struct Batch 

pub struct Batch<T, Request>
where
    T: Service<BatchControl<Request>>,
{ /* private fields */ }

Handle for submitting requests to a batch worker.

Each Batch handle communicates with a single background worker over a shared channel. Handles are cheap to Clone – every clone sends to the same worker, so you can hand them to multiple tasks.

See the module documentation for the full lifecycle and error semantics.

Implementations

impl<T, Request> Batch<T, Request>

where T: Service<BatchControl<Request>>, T::Error: Into<BoxError>,

pub fn new(service: T, size: usize, time: Duration) -> Self

where T: Send + 'static, T::Future: Send, T::Error: Send + Sync, Request: Send + 'static,

Creates a new Batch wrapping service.

size is the maximum number of items per batch and time is the maximum duration before a batch is flushed. The worker flushes whichever limit is hit first.

The background worker is spawned on the default Tokio executor, so this method must be called while on the Tokio runtime.

pub fn pair( service: T, size: usize, time: Duration, ) -> (Self, Worker<T, Request>)

where T: Send + 'static, T::Future: Send, T::Error: Send + Sync, Request: Send + 'static,

Creates a new Batch 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 Batch and the background Worker that you can then spawn.

Trait Implementations

impl<T, Request> Clone for Batch<T, Request>

where T: Service<BatchControl<Request>>,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, Request: Debug> Debug for Batch<T, Request>

where T: Service<BatchControl<Request>> + Debug, T::Future: Debug,

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

Formats the value using the given formatter.

impl<T, Request> Service<Request> for Batch<T, Request>

where T: Service<BatchControl<Request>>, T::Error: Into<BoxError>,

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

Responses given by the service.

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

Errors produced by the service.

type Future = ResponseFuture<<T as Service<BatchControl<Request>>>::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.