Struct Encoder 

pub struct Encoder<B> { /* private fields */ }

Available on crate feature __compress only.

Response body that compresses chunks using a content encoding.

Implements MessageBody and reports BodySize::Stream when compression is enabled. Buffered output is flushed when the underlying body returns Poll::Pending, and the compressed stream is finalized when the body ends.

See Encoder::response for conditions that skip compression and the module-level docs for supported encodings and runtime requirements.

Implementations

impl<B: MessageBody> Encoder<B>

pub fn response( encoding: ContentEncoding, head: &mut ResponseHead, body: B, ) -> Self

Constructs a response body encoder and updates the response head if compression is enabled.

Compression is skipped when:

• The body size is BodySize::None or BodySize::Sized(0).
• The response already has a Content-Encoding header.
• The response status is 101 Switching Protocols, 204 No Content, or 206 Partial Content.
• encoding is ContentEncoding::Identity or its codec feature is disabled.

Otherwise, sets Content-Encoding, appends accept-encoding to Vary, and enables chunked transfer encoding in the response head. Existing Content-Length headers are not removed.

The caller must select encoding; this method does not negotiate Accept-Encoding.

Trait Implementations

impl<B> MessageBody for Encoder<B>

where B: MessageBody,

type Error = EncoderError

The type of error that will be returned if streaming body fails.

fn size(&self) -> BodySize

Body size hint.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Bytes, Self::Error>>>

Attempt to pull out the next chunk of body bytes.

fn try_into_bytes(self) -> Result<Bytes, Self>

where Self: Sized,

Try to convert into the complete chunk of body bytes.

fn boxed(self) -> BoxBody

where Self: Sized + 'static,

Wraps this body into a BoxBody.

impl<'__pin, B> Unpin for Encoder<B>

where PinnedFieldsOf<__Origin<'__pin, B>>: Unpin,