[−][src]Trait tokio_util::codec::Encoder

pub trait Encoder {
    type Item;
    type Error: From<Error>;
    fn encode(
        &mut self, 
        item: Self::Item, 
        dst: &mut BytesMut
    ) -> Result<(), Self::Error>;
}
This is supported on feature="codec" only.

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

Associated Types

type Item

This is supported on feature="codec" only.

The type of items consumed by the Encoder

type Error: From<Error>

This is supported on feature="codec" only.

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

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

This is supported on feature="codec" only.

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.

Loading content...

Implementors

impl Encoder for LengthDelimitedCodec[src]

type Item = Bytes

This is supported on feature="codec" only.

type Error = Error

This is supported on feature="codec" only.

impl Encoder for BytesCodec[src]

type Item = Bytes

This is supported on feature="codec" only.

type Error = Error

This is supported on feature="codec" only.

impl Encoder for LinesCodec[src]

type Item = String

This is supported on feature="codec" only.

type Error = LinesCodecError

This is supported on feature="codec" only.
Loading content...