Struct tower::buffer::Buffer[−][src]

pub struct Buffer<T, Request> where
    T: Service<Request>,  { /* fields omitted */ }
This is supported on crate feature buffer only.
Expand description

Adds an mpsc buffer in front of an inner service.

See the module documentation for more details.

Implementations

impl<T, Request> Buffer<T, Request> where
    T: Service<Request>,
    T::Error: Into<BoxError>, [src]

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

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.

A note on choosing a bound

When Buffer’s implementation of poll_ready returns Poll::Ready, it reserves a slot in the channel for the forthcoming call. However, if this call doesn’t arrive, this reserved slot may be held up for a long time. As a result, it’s advisable to set bound to be at least the maximum number of concurrent requests the Buffer will see. If you do not, all the slots in the buffer may be held up by futures that have just called poll_ready but will not issue a call, which prevents other senders from issuing new requests.

pub fn pair(
    service: T,
    bound: usize
) -> (Buffer<T, Request>, Worker<T, Request>) where
    T: Send + 'static,
    T::Error: Send + Sync,
    Request: Send + 'static, [src]

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>, [src]

fn clone(&self) -> Self[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl<T, Request> Service<Request> for Buffer<T, Request> where
    T: Service<Request>,
    T::Error: Into<BoxError>, [src]

type Response = T::Response

Responses given by the service.

type Error = BoxError

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>>[src]

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

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

Process the request and return the response asynchronously. Read more

Auto Trait Implementations

impl<T, Request> !RefUnwindSafe for Buffer<T, Request>

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

impl<T, Request> Sync for Buffer<T, Request> where
    Request: Send,
    <T as Service<Request>>::Future: Send, 

impl<T, Request> Unpin for Buffer<T, Request>

impl<T, Request> !UnwindSafe for Buffer<T, Request>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, Request> ServiceExt<Request> for T where
    T: Service<Request> + ?Sized, [src]

fn ready(&mut self) -> Ready<'_, Self, Request>ⓘ

Notable traits for Ready<'a, T, Request>

impl<'a, T, Request> Future for Ready<'a, T, Request> where
    T: Service<Request>,  type Output = Result<&'a mut T, T::Error>;
 where
    Self: Sized, [src]

This is supported on crate feature util only.

Yields a mutable reference to the service when it is ready to accept a request.

fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request> where
    Self: Sized, [src]

👎 Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

This is supported on crate feature util only.

Yields a mutable reference to the service when it is ready to accept a request.

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>ⓘ

Notable traits for ReadyOneshot<T, Request>

impl<T, Request> Future for ReadyOneshot<T, Request> where
    T: Service<Request>,  type Output = Result<T, T::Error>;
 where
    Self: Sized, [src]

This is supported on crate feature util only.

Yields the service when it is ready to accept a request.

fn oneshot(self, req: Request) -> Oneshot<Self, Request>ⓘ

Notable traits for Oneshot<S, Req>

impl<S, Req> Future for Oneshot<S, Req> where
    S: Service<Req>,  type Output = Result<S::Response, S::Error>;
 where
    Self: Sized, [src]

This is supported on crate feature util only.

Consume this Service, calling with the providing request once it is ready.

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
    Self: Sized,
    Self::Error: Into<BoxError>,
    S: Stream<Item = Request>, [src]

This is supported on crate feature util only.

Process all requests from the given Stream, and produce a Stream of their responses. Read more

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
    Self: Sized,
    F: Clone, [src]

This is supported on crate feature util only.

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
    Self: Sized,
    F: FnOnce(Self::Response) -> Response + Clone, [src]

This is supported on crate feature util only.

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
    Self: Sized,
    F: FnOnce(Self::Error) -> Error + Clone, [src]

This is supported on crate feature util only.

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
    Self: Sized,
    Error: From<Self::Error>,
    F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone, [src]

This is supported on crate feature util only.

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
    Self: Sized,
    F: FnMut(NewRequest) -> Request + Clone, [src]

This is supported on crate feature util only.

Composes a function in front of the service. Read more

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where
    Self: Sized,
    F: Predicate<NewRequest>, [src]

This is supported on crate features util and filter only.

Composes this service with a Filter that conditionally accepts or rejects requests based on a predicate. Read more

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where
    Self: Sized,
    F: AsyncPredicate<NewRequest>, [src]

This is supported on crate features util and filter only.

Composes this service with an AsyncFilter that conditionally accepts or rejects requests based on an [async predicate]. Read more

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
    Self: Sized,
    Error: From<Self::Error>,
    F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
    Fut: Future<Output = Result<Response, Error>>, [src]

This is supported on crate feature util only.

Composes an asynchronous function after this service. Read more

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
    Self: Sized,
    F: FnMut(Self::Future) -> Fut,
    Error: From<Self::Error>,
    Fut: Future<Output = Result<Response, Error>>, [src]

This is supported on crate feature util only.

Composes a function that transforms futures produced by the service. Read more

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V