Skip to main content

CompressionLayer

rama::http::layer::compression

Struct CompressionLayer 

pub struct CompressionLayer<P = DefaultPredicate> { /* private fields */ }
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 CompressionLayer

pub fn new() -> CompressionLayer

Creates a new CompressionLayer.

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

Replace the current compression predicate.

§

impl<P> CompressionLayer<P>

pub fn with_gzip(self, enable: bool) -> CompressionLayer<P>

Sets whether to enable the gzip encoding.

pub fn set_gzip(&mut self, enable: bool) -> &mut CompressionLayer<P>

Sets whether to enable the gzip encoding.

pub fn with_deflate(self, enable: bool) -> CompressionLayer<P>

Sets whether to enable the Deflate encoding.

pub fn set_deflate(&mut self, enable: bool) -> &mut CompressionLayer<P>

Sets whether to enable the Deflate encoding.

pub fn with_br(self, enable: bool) -> CompressionLayer<P>

Sets whether to enable the Brotli encoding.

pub fn set_br(&mut self, enable: bool) -> &mut CompressionLayer<P>

Sets whether to enable the Brotli encoding.

pub fn with_zstd(self, enable: bool) -> CompressionLayer<P>

Sets whether to enable the Zstd encoding.

pub fn set_zstd(&mut self, enable: bool) -> &mut CompressionLayer<P>

Sets whether to enable the Zstd encoding.

pub fn with_quality(self, quality: CompressionLevel) -> CompressionLayer<P>

Sets the compression quality.

pub fn set_quality( &mut self, quality: CompressionLevel, ) -> &mut CompressionLayer<P>

Sets the compression quality.

pub fn with_respect_content_encoding_if_possible(self) -> CompressionLayer<P>

Allow responses with content-encoding.

Useful in case your stack uses that response header as preference. Not something you want for regular servers or proxies however, or most use cases for that matter.

pub fn set_respect_content_encoding_if_possible( &mut self, ) -> &mut CompressionLayer<P>

Allow responses with content-encoding.

Useful in case your stack uses that response header as preference. Not something you want for regular servers or proxies however, or most use cases for that matter.

Trait Implementations§

§

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

§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

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

§

fn default() -> CompressionLayer<P>

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

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

§

type Service = Compression<S, P>

The service produced by the layer.
§

fn layer(&self, inner: S) -> <CompressionLayer<P> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.
§

fn into_layer(self, inner: S) -> <CompressionLayer<P> as Layer<S>>::Service

Same as layer but consuming self after the service was created. Read more

Auto Trait Implementations§

§

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

§

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§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

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

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

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

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

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

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

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

§

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

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

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

Source§

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

impl<T> Extension for T
where T: Any + Send + Sync + Debug + 'static,