Struct tower_http::compression::CompressionLayer

source · [−]

pub struct CompressionLayer<P = DefaultPredicate> { /* private fields */ }

This is supported on crate features compression-br or compression-deflate or compression-gzip only.

Expand description

Compress response bodies of the underlying service.

This uses the Accept-Encoding header to pick an appropriate encoding and adds the Content-Encoding header to responses.

See the module docs for more details.

Implementations

source

impl CompressionLayer

source

pub fn new() -> Self

Create a new CompressionLayer

source

pub fn gzip(self, enable: bool) -> Self

This is supported on crate feature compression-gzip only.

Sets whether to enable the gzip encoding.

source

pub fn deflate(self, enable: bool) -> Self

This is supported on crate feature compression-deflate only.

Sets whether to enable the Deflate encoding.

source

pub fn br(self, enable: bool) -> Self

This is supported on crate feature compression-br only.

Sets whether to enable the Brotli encoding.

source

pub fn no_gzip(self) -> Self

Disables the gzip encoding.

This method is available even if the gzip crate feature is disabled.

source

pub fn no_deflate(self) -> Self

Disables the Deflate encoding.

This method is available even if the deflate crate feature is disabled.

source

pub fn no_br(self) -> Self

Disables the Brotli encoding.

This method is available even if the br crate feature is disabled.

source

pub fn compress_when<C>(self, predicate: C) -> CompressionLayer<C> where
C: Predicate,

Replace the current compression predicate.

See Compression::compress_when for more details.

Trait Implementations

source

impl<P: Clone> Clone for CompressionLayer

source

fn clone(&self) -> CompressionLayer

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<P: Debug> Debug for CompressionLayer

source

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

Formats the value using the given formatter. Read more

source

impl<P: Default> Default for CompressionLayer

source

fn default() -> CompressionLayer

Returns the “default value” for a type. Read more

source

impl<S, P> Layer<S> for CompressionLayer where
P: Predicate,

type Service = Compression<S, P>

The wrapped service

source

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

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

Auto Trait Implementations

impl RefUnwindSafe for CompressionLayer where
P: RefUnwindSafe,

impl Send for CompressionLayer where
P: Send,

impl Sync for CompressionLayer where
P: Sync,

impl Unpin for CompressionLayer where
P: Unpin,

impl UnwindSafe for CompressionLayer where
P: UnwindSafe,

Blanket Implementations

source

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

source

pub 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

pub 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

pub 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

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

source

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

source

pub fn and<P, B, E>(Self, P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

This is supported on crate feature follow-redirect only.

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

source

pub fn or<P, B, E>(Self, P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

This is supported on crate feature follow-redirect only.

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

Uses borrowed data to replace owned data, usually by cloning. 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

pub 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

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

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct tower_http::compression::CompressionLayer

Implementations

impl CompressionLayer

pub fn new() -> Self

pub fn gzip(self, enable: bool) -> Self

pub fn deflate(self, enable: bool) -> Self

pub fn br(self, enable: bool) -> Self

pub fn no_gzip(self) -> Self

pub fn no_deflate(self) -> Self

pub fn no_br(self) -> Self

pub fn compress_when<C>(self, predicate: C) -> CompressionLayer<C> where C: Predicate,

Trait Implementations

impl<P: Clone> Clone for CompressionLayer<P>

fn clone(&self) -> CompressionLayer<P>

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

impl<P: Debug> Debug for CompressionLayer<P>

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

impl<P: Default> Default for CompressionLayer<P>

fn default() -> CompressionLayer<P>

impl<S, P> Layer<S> for CompressionLayer<P> where P: Predicate,

type Service = Compression<S, P>

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

Auto Trait Implementations

impl<P> RefUnwindSafe for CompressionLayer<P> where P: RefUnwindSafe,

impl<P> Send for CompressionLayer<P> where P: Send,

impl<P> Sync for CompressionLayer<P> where P: Sync,

impl<P> Unpin for CompressionLayer<P> where P: Unpin,

impl<P> UnwindSafe for CompressionLayer<P> where P: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

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

pub fn into(self) -> U

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

pub fn and<P, B, E>(Self, P) -> And<T, P> where T: Policy<B, E>, P: Policy<B, E>,

pub fn or<P, B, E>(Self, P) -> Or<T, P> where T: Policy<B, E>, P: Policy<B, E>,

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

pub 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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn compress_when<C>(self, predicate: C) -> CompressionLayer<C> where
C: Predicate,

impl<S, P> Layer<S> for CompressionLayer<P> where
P: Predicate,

impl<P> RefUnwindSafe for CompressionLayer<P> where
P: RefUnwindSafe,

impl<P> Send for CompressionLayer<P> where
P: Send,

impl<P> Sync for CompressionLayer<P> where
P: Sync,

impl<P> Unpin for CompressionLayer<P> where
P: Unpin,

impl<P> UnwindSafe for CompressionLayer<P> where
P: UnwindSafe,

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> PolicyExt for T where
T: ?Sized,

pub fn and<P, B, E>(Self, P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

pub fn or<P, B, E>(Self, P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

impl<T> ToOwned for T where
T: Clone,

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,