# tokio_util::codec::Encoder - Rust
API documentation for the Rust `Encoder` trait in crate `tokio_util`.
Keywords: rust, rustlang, rust-lang, Encoder

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

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

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

## Associated Types

### `type Error: From<Error>` [src]

The type of encoding errors.

`FramedWrite` requires `Encoder`s errors to implement `From<io::Error>` in the interest letting it return `Error`s directly.

Loading content...

## Required methods

### `fn encode(&mut self, item: Item, dst: &mut BytesMut) -> Result<(), Self::Error>` [src]

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` [src]

#### `type Error = Error`

#### `fn encode(&mut self, data: Bytes, dst: &mut BytesMut) -> Result<(), Error>` [src]

### `impl Encoder<Bytes> for BytesCodec` [src]

#### `type Error = Error`

#### `fn encode(&mut self, data: Bytes, buf: &mut BytesMut) -> Result<(), Error>` [src]

### `impl<T> Encoder<T> for AnyDelimiterCodec where
T: AsRef<str>,` [src]

#### `type Error = AnyDelimiterCodecError`

#### `fn encode(
&mut self,
chunk: T,
buf: &mut BytesMut
) -> Result<(), AnyDelimiterCodecError>` [src]

### `impl<T> Encoder<T> for LinesCodec where
T: AsRef<str>,` [src]

#### `type Error = LinesCodecError`

#### `fn encode(&mut self, line: T, buf: &mut BytesMut) -> Result<(), LinesCodecError>` [src]

Loading content...