Struct HeadBodyEncoder

pub struct HeadBodyEncoder<E>(/* private fields */);

A body encoder mainly intended to be used for encoding HEAD responses.

HeadBodyDecoder updates HTTP header ordinally but discards all data produced by the inner encoder.

Implementations

impl<E: BodyEncode> HeadBodyEncoder<E>

pub fn new(inner: E) -> Self

Makes a new HeadBodyEncoder instance.

pub fn inner_ref(&self) -> &E

Returns a reference to a inner body encoder.

pub fn inner_mut(&mut self) -> &mut E

Returns a mutable reference to a inner body encoder.

pub fn into_inner(self) -> E

Takes ownership of HeadBodyEncoder and returns the inner body encoder.

Trait Implementations

impl<E: BodyEncode> BodyEncode for HeadBodyEncoder<E>

fn update_header(&self, header: &mut HeaderMut<'_>) -> Result<()>

This method is called before starting to encode a HTTP body.

impl<E: Debug> Debug for HeadBodyEncoder<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for HeadBodyEncoder<E>

fn default() -> HeadBodyEncoder<E>

Returns the “default value” for a type.

impl<E: BodyEncode> Encode for HeadBodyEncoder<E>

type Item = <E as Encode>::Item

The type of items to be encoded.

fn encode(&mut self, _buf: &mut [u8], _eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, item: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

impl<E: BodyEncode> SizedEncode for HeadBodyEncoder<E>

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.