Struct BytesCodec

pub struct BytesCodec(/* private fields */);

A simple Decoder and Encoder implementation that just ships bytes around.

Example

Turn an AsyncRead into a stream of Result<BytesMut, Error>.

use tokio::fs::File;
use tokio::io::AsyncRead;
use tokio_util::codec::{FramedRead, BytesCodec};

let my_async_read = File::open("filename.txt").await?;
let my_stream_of_bytes = FramedRead::new(my_async_read, BytesCodec::new());

Implementations

impl BytesCodec

pub fn new() -> BytesCodec

Creates a new BytesCodec for shipping around raw bytes.

Trait Implementations

impl Clone for BytesCodec

fn clone(&self) -> BytesCodec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BytesCodec

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Decoder for BytesCodec

type Item = BytesMut

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

Attempts to decode a frame from the provided buffer of bytes.

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

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for BytesCodec

fn default() -> BytesCodec

Returns the “default value” for a type.

impl Encoder<Bytes> for BytesCodec

type Error = Error

The type of encoding errors.

fn encode(&mut self, data: Bytes, buf: &mut BytesMut) -> Result<(), Error>

Encodes a frame into the buffer provided.

impl Encoder<BytesMut> for BytesCodec

type Error = Error

The type of encoding errors.

fn encode(&mut self, data: BytesMut, buf: &mut BytesMut) -> Result<(), Error>

Encodes a frame into the buffer provided.

impl Hash for BytesCodec

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BytesCodec

fn cmp(&self, other: &BytesCodec) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BytesCodec

fn eq(&self, other: &BytesCodec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BytesCodec

fn partial_cmp(&self, other: &BytesCodec) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for BytesCodec

impl Eq for BytesCodec

impl StructuralPartialEq for BytesCodec