Struct tower_http::compression::Compression[−][src]

pub struct Compression<S> { /* fields omitted */ }
This is supported on crate feature compression 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

impl<S> Compression<S>[src]

pub fn new(service: S) -> Self[src]

Creates a new Compression wrapping the service.

pub fn get_ref(&self) -> &S[src]

Gets a reference to the underlying service.

pub fn get_mut(&mut self) -> &mut S[src]

Gets a mutable reference to the underlying service.

pub fn into_inner(self) -> S[src]

Consumes self, returning the underlying service.

pub fn layer() -> CompressionLayer[src]

Returns a new Layer that wraps services with a Compression middleware.

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

This is supported on crate feature compression-gzip only.

Sets whether to enable the gzip encoding.

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

This is supported on crate feature compression-deflate only.

Sets whether to enable the Deflate encoding.

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

This is supported on crate feature compression-br only.

Sets whether to enable the Brotli encoding.

pub fn no_gzip(self) -> Self[src]

Disables the gzip encoding.

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

pub fn no_deflate(self) -> Self[src]

Disables the Deflate encoding.

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

pub fn no_br(self) -> Self[src]

Disables the Brotli encoding.

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

Trait Implementations

impl<S: Clone> Clone for Compression<S>[src]

fn clone(&self) -> Compression<S>[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<ReqBody, ResBody, S> Service<Request<ReqBody>> for Compression<S> where
    S: Service<Request<ReqBody>, Response = Response<ResBody>>,
    ResBody: Body,
    ResBody::Error: Into<Box<dyn Error + Send + Sync>>, [src]

type Response = Response<CompressionBody<ResBody>>

Responses given by the service.

type Error = S::Error

Errors produced by the service.

type Future = ResponseFuture<S::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, req: Request<ReqBody>) -> Self::Future[src]

Process the request and return the response asynchronously. Read more

impl<S: Copy> Copy for Compression<S>[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for Compression<S> where
    S: RefUnwindSafe, 

impl<S> Send for Compression<S> where
    S: Send, 

impl<S> Sync for Compression<S> where
    S: Sync, 

impl<S> Unpin for Compression<S> where
    S: Unpin, 

impl<S> UnwindSafe for Compression<S> where
    S: UnwindSafe, 

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

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

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

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

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

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

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

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

fn ready_and(&mut self) -> Ready<'_, Self, Request>[src]

👎 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.

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>[src]

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

fn oneshot(self, req: Request) -> Oneshot<Self, Request>[src]

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

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
    S: Stream<Item = Request>,
    Self::Error: Into<Box<dyn Error + 'static + Sync + Send, Global>>, [src]

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

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
    F: FnOnce(Self::Response) -> Response + Clone, [src]

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
    F: FnOnce(Self::Error) -> Error + Clone, [src]

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
    Error: From<Self::Error>,
    F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone, [src]

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
    F: FnMut(NewRequest) -> Request + Clone, [src]

Composes a function in front of the service. Read more

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

Composes an asynchronous function after this service. Read more

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

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.