Struct tokio_yamux::frame::FrameCodec

pub struct FrameCodec { /* private fields */ }

The frame decoder/encoder

Implementations

impl FrameCodec

pub fn max_frame_size(self, size: u32) -> Self

Set max frame size

Trait Implementations

impl Decoder for FrameCodec

type Item = Frame

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut ) -> Result<Option<Self::Item>, Self::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 FrameCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Frame> for FrameCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.