Trait tokio_util::codec::Encoder

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

This is supported on crate feature codec only.

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

Associated Types

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.

Loading content...

Required methods

pub fn encode(
    &mut self,
    item: 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 FramedWrite instance and will be written out when possible.

Loading content...

Implementors

impl Encoder<Bytes> for LengthDelimitedCodec

type Error = Error

pub fn encode(&mut self, data: Bytes, dst: &mut BytesMut) -> Result<(), Error>

impl Encoder<Bytes> for BytesCodec

type Error = Error

pub fn encode(&mut self, data: Bytes, buf: &mut BytesMut) -> Result<(), Error>

impl<T> Encoder<T> for LinesCodec where
    T: AsRef<str>, 

type Error = LinesCodecError

pub fn encode(
    &mut self,
    line: T,
    buf: &mut BytesMut
) -> Result<(), LinesCodecError>

Loading content...