Trait tokio::codec::Encoder

source · [−]

pub trait Encoder {
    type Item;
    type Error: From<Error>;
    fn encode(
        &mut self, 
        item: Self::Item, 
        dst: &mut BytesMut
    ) -> Result<(), Self::Error>;
}

Expand description

Trait of helper objects to write out messages as bytes, for use with FramedWrite.

Associated Types

source

type Item

The type of items consumed by the Encoder

source

type Error: From<Error>

The type of encoding errors.

FramedWrite requires Encoders errors to implement From<io::Error> in the interest letting it return Errors directly.

Required methods

source

fn encode(
    &mut self,
    item: Self::Item,
    dst: &mut BytesMut
) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

This method will encode item into the byte buffer provided by dst. The dst provided is an internal buffer of the Framed instance and will be written out when possible.