Struct futures_codec::BytesCodec

pub struct BytesCodec;

A simple codec that ships bytes around

Example

use bytes::Bytes;
use futures::{SinkExt, TryStreamExt};
use futures::io::Cursor;
use futures_codec::{BytesCodec, Framed};

let mut buf = vec![];
// Cursor implements AsyncRead and AsyncWrite
let cur = Cursor::new(&mut buf);
let mut framed = Framed::new(cur, BytesCodec);

framed.send(Bytes::from("Hello World!")).await?;

while let Some(bytes) = framed.try_next().await? {
   dbg!(bytes);
}

Trait Implementations

impl Decoder for BytesCodec

type Item = Bytes

The type of items returned by decode

type Error = Error

The type of decoding errors.

fn decode(
    &mut self,
    src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

Decode an item from the src BytesMut into an item

fn decode_eof(
    &mut self,
    src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

Called when the input stream reaches EOF, signaling a last attempt to decode

impl Encoder for BytesCodec

type Item = Bytes

The type of items consumed by encode

type Error = Error

The type of encoding errors.

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

Encodes an item into the BytesMut provided by dst.