Struct futures_codec::LinesCodec

pub struct LinesCodec;

A simple Codec implementation that splits up data into lines.

use futures::stream::TryStreamExt; // for lines.try_next()
use futures_codec::{FramedRead, LinesCodec};

let input = "hello\nworld\nthis\nis\ndog\n".as_bytes();
let mut lines = FramedRead::new(input, LinesCodec);
while let Some(line) = lines.try_next().await? {
    println!("{}", line);
}

Trait Implementations

impl Decoder for LinesCodec

type Item = String

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 LinesCodec

type Item = String

The type of items consumed by encode

type Error = Error

The type of encoding errors.

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

Encodes an item into the BytesMut provided by dst.