mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-18 00:00:09 +02:00
Carl Lerche
878503f965
Updates API documentation for - tokio-buf - tokio-codec - tokio-current-thread - tokio-executor
23 lines
786 B
Rust
23 lines
786 B
Rust
use bytes::BytesMut;
|
|
use std::io;
|
|
|
|
/// Trait of helper objects to write out messages as bytes, for use with
|
|
/// `FramedWrite`.
|
|
pub trait Encoder {
|
|
/// The type of items consumed by the `Encoder`
|
|
type Item;
|
|
|
|
/// The type of encoding errors.
|
|
///
|
|
/// `FramedWrite` requires `Encoder`s errors to implement `From<io::Error>`
|
|
/// in the interest letting it return `Error`s directly.
|
|
type Error: From<io::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.
|
|
fn encode(&mut self, item: Self::Item, dst: &mut BytesMut) -> Result<(), Self::Error>;
|
|
}
|