Skip to main content

FrameCodec

Struct FrameCodec 

Source
pub struct FrameCodec { /* private fields */ }
Expand description

Frame codec for encoding/decoding messages

Implementations§

Source§

impl FrameCodec

Source

pub fn new() -> Self

Create a new frame codec with default max size

Source

pub fn with_max_size(max_size: u32) -> Self

Create a frame codec with custom max size

Source

pub fn max_size(&self) -> u32

Get the maximum message size

Source

pub fn feed(&mut self, data: &[u8])

Feed data into the codec’s internal buffer

Source

pub fn has_complete_frame(&self) -> bool

Check if there’s enough data for a complete frame

Source

pub fn buffer_size(&self) -> usize

Get the current buffer size

Source

pub fn clear(&mut self)

Clear the internal buffer

Source

pub fn decode(&mut self) -> Result<Option<Bytes>, FrameError>

Decode a frame from the internal buffer Returns None if incomplete, Some(bytes) if complete

Source

pub fn decode_from( &self, src: &mut BytesMut, ) -> Result<Option<Bytes>, FrameError>

Decode a frame from the provided buffer Returns None if incomplete, Some(bytes) if complete

Source

pub fn encode(&self, msg: &[u8], dst: &mut BytesMut) -> Result<(), FrameError>

Encode a message into a frame

Source

pub fn encode_to_bytes(&self, msg: &[u8]) -> Result<Bytes, FrameError>

Encode a message and return the framed bytes

Trait Implementations§

Source§

impl Debug for FrameCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FrameCodec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V