Struct tower::util::BoxService

source · [−]

pub struct BoxService<T, U, E> { /* private fields */ }

Expand description

A boxed Service + Send trait object.

BoxService turns a service into a trait object, allowing the response future type to be dynamic. This type requires both the service and the response future to be Send.

See module level documentation for more details.

Implementations

source

impl<T, U, E> BoxService<T, U, E>

source

pub fn new<S>(inner: S) -> Self where
S: Service<T, Response = U, Error = E> + Send + 'static,
S::Future: Send + 'static,

source

pub fn layer<S>() -> LayerFn<fn(_: S) -> Self> where
S: Service<T, Response = U, Error = E> + Send + 'static,
S::Future: Send + 'static,

Returns a Layer for wrapping a Service in a BoxService middleware.

Trait Implementations

source

impl<T, U, E> Debug for BoxService<T, U, E> where
 T: Debug,
 U: Debug,
 E: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<T, U, E> Service<T> for BoxService<T, U, E>

type Response = U

Responses given by the service.

type Error = E

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<U, E>> + Send + 'static, Global>>

The future response value.

source

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

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

source

fn call(
&mut self,
request: T
) -> Pin<Box<dyn Future<Output = Result<U, E>> + Send>>

Process the request and return the response asynchronously. Read more

Auto Trait Implementations

impl<T, U, E> !RefUnwindSafe for BoxService<T, U, E>

impl<T, U, E> Send for BoxService<T, U, E>

impl<T, U, E> !Sync for BoxService<T, U, E>

impl<T, U, E> Unpin for BoxService<T, U, E>

impl<T, U, E> !UnwindSafe for BoxService<T, U, E>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

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

source

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,

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

source

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

👎Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

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

source

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,

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

source

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,

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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,

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

source

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

Composes a function in front of the service. Read more

source

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>>,

Composes an asynchronous function after this service. Read more

source

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>>,

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct tower::util::BoxService

Implementations

impl<T, U, E> BoxService<T, U, E>

pub fn new<S>(inner: S) -> Self where S: Service<T, Response = U, Error = E> + Send + 'static, S::Future: Send + 'static,

pub fn layer<S>() -> LayerFn<fn(_: S) -> Self> where S: Service<T, Response = U, Error = E> + Send + 'static, S::Future: Send + 'static,

Trait Implementations

impl<T, U, E> Debug for BoxService<T, U, E> where T: Debug, U: Debug, E: Debug,

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

impl<T, U, E> Service<T> for BoxService<T, U, E>

type Response = U

type Error = E

type Future = Pin<Box<dyn Future<Output = Result<U, E>> + Send + 'static, Global>>

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

fn call( &mut self, request: T) -> Pin<Box<dyn Future<Output = Result<U, E>> + Send>>

Auto Trait Implementations

impl<T, U, E> !RefUnwindSafe for BoxService<T, U, E>

impl<T, U, E> Send for BoxService<T, U, E>

impl<T, U, E> !Sync for BoxService<T, U, E>

impl<T, U, E> Unpin for BoxService<T, U, E>

impl<T, U, E> !UnwindSafe for BoxService<T, U, E>

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

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

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,

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

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,

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,

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

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

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

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

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,

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

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>>,

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>>,

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

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

fn vzip(self) -> V

pub fn new<S>(inner: S) -> Self where
S: Service<T, Response = U, Error = E> + Send + 'static,
S::Future: Send + 'static,

pub fn layer<S>() -> LayerFn<fn(_: S) -> Self> where
S: Service<T, Response = U, Error = E> + Send + 'static,
S::Future: Send + 'static,

impl<T, U, E> Debug for BoxService<T, U, E> where
T: Debug,
U: Debug,
E: Debug,

fn call(
&mut self,
request: T
) -> Pin<Box<dyn Future<Output = Result<U, E>> + Send>>

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

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,

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

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,

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,

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

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

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

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

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,

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

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>>,

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>>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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