Struct httpcodec::BodyEncoder

pub struct BodyEncoder<E>(_);

Basic HTTP body encoder.

It is typically used for making a body encoder from a Encode implementor.

If E::requiring_bytes() returns ByteCount::Unknown, the chunked body transfer encoding will be used.

Methods

impl<E> BodyEncoder<E>

pub fn new(inner: E) -> Self

Makes a new BodyEncoder instance.

Trait Implementations

impl<E: Debug> Debug for BodyEncoder<E>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<E: Default> Default for BodyEncoder<E>

fn default() -> BodyEncoder<E>

Returns the "default value" for a type.

impl<E: Encode> Encode for BodyEncoder<E>

type Item = E::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: Encode> BodyEncode for BodyEncoder<E>

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

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