Struct FrameCodec 

pub struct FrameCodec { /* private fields */ }

Frame codec for encoding/decoding frames over async streams

Implementations

impl FrameCodec

pub fn new() -> Self

Create a new frame codec with default settings

pub fn with_max_frame_size(max_frame_size: usize) -> Self

Create a new frame codec with custom max frame size

pub fn encode_frame(&self, frame: &Frame) -> Result<Bytes, ProtocolError>

Encode a frame to bytes with length prefix

pub async fn write_frame<W>( &self, writer: &mut W, frame: &Frame, ) -> Result<(), ProtocolError>

where W: AsyncWrite + Unpin,

Write a frame to an async writer

pub async fn read_frame<R>( &mut self, reader: &mut R, ) -> Result<Option<Frame>, ProtocolError>

where R: AsyncRead + Unpin,

Read a frame from an async reader

pub fn try_decode_frame(&mut self) -> Result<Option<Frame>, ProtocolError>

Try to decode a frame from the internal buffer

pub fn buffer_size(&self) -> usize

Get the current buffer size

pub fn clear_buffer(&mut self)

Clear the internal buffer

Trait Implementations

impl Default for FrameCodec

fn default() -> Self

Returns the “default value” for a type.