Struct tower::util::BoxLayer

source ·
pub struct BoxLayer<In, T, U, E> { /* private fields */ }
Expand description

A boxed Layer trait object.

BoxLayer turns a layer into a trait object, allowing both the Layer itself and the output Service to be dynamic, while having consistent types.

This Layer produces BoxService instances erasing the type of the Service produced by the wrapped Layer.

§Example

BoxLayer can, for example, be useful to create layers dynamically that otherwise wouldn’t have the same types. In this example, we include a Timeout layer only if an environment variable is set. We can use BoxLayer to return a consistent type regardless of runtime configuration:

use std::time::Duration;
use tower::{Service, ServiceBuilder, BoxError, util::BoxLayer};

fn common_layer<S, T>() -> BoxLayer<S, T, S::Response, BoxError>
where
    S: Service<T> + Send + 'static,
    S::Future: Send + 'static,
    S::Error: Into<BoxError> + 'static,
{
    let builder = ServiceBuilder::new()
        .concurrency_limit(100);

    if std::env::var("SET_TIMEOUT").is_ok() {
        let layer = builder
            .timeout(Duration::from_secs(30))
            .into_inner();

        BoxLayer::new(layer)
    } else {
        let layer = builder
            .map_err(Into::into)
            .into_inner();

        BoxLayer::new(layer)
    }
}

Implementations§

source§

impl<In, T, U, E> BoxLayer<In, T, U, E>

source

pub fn new<L>(inner_layer: L) -> Self
where L: Layer<In> + Send + Sync + 'static, L::Service: Service<T, Response = U, Error = E> + Send + 'static, <L::Service as Service<T>>::Future: Send + 'static,

Create a new BoxLayer.

Trait Implementations§

source§

impl<In, T, U, E> Clone for BoxLayer<In, T, U, E>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<In, T, U, E> Debug for BoxLayer<In, T, U, E>

source§

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

Formats the value using the given formatter. Read more
source§

impl<In, T, U, E> Layer<In> for BoxLayer<In, T, U, E>

§

type Service = BoxService<T, U, E>

The wrapped service
source§

fn layer(&self, inner: In) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

Auto Trait Implementations§

§

impl<In, T, U, E> Freeze for BoxLayer<In, T, U, E>

§

impl<In, T, U, E> !RefUnwindSafe for BoxLayer<In, T, U, E>

§

impl<In, T, U, E> Send for BoxLayer<In, T, U, E>

§

impl<In, T, U, E> Sync for BoxLayer<In, T, U, E>

§

impl<In, T, U, E> Unpin for BoxLayer<In, T, U, E>

§

impl<In, T, U, E> !UnwindSafe for BoxLayer<In, 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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.