Struct Frame 

pub struct Frame<'a> { /* private fields */ }

A frame extracted from an input byte slice.

The payload borrow lives as long as the input slice, so framers never copy data. consumed tells the caller how many bytes from the input the frame occupied in total, including any header or delimiter bytes.

Implementations

impl<'a> Frame<'a>

pub const fn new(payload: &'a [u8], consumed: usize) -> Self

Construct a frame from its payload and total consumed-byte count.

consumed must be at least payload.len(); framers in this crate uphold that invariant.

pub const fn payload(&self) -> &'a [u8]

Zero-copy borrow of the frame payload.

pub const fn consumed(&self) -> usize

Number of bytes the framer consumed from the input to produce this frame.

Trait Implementations

impl<'a> Clone for Frame<'a>

fn clone(&self) -> Frame<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Frame<'a>

fn eq(&self, other: &Frame<'a>) -> 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<'a> Copy for Frame<'a>

impl<'a> Eq for Frame<'a>

impl<'a> StructuralPartialEq for Frame<'a>