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.

Example

use wire_codec::framing::Frame;

let input = b"\x03abcrest";
let frame = Frame::new(&input[1..4], 4);
assert_eq!(frame.payload(), b"abc");
assert_eq!(frame.consumed(), 4);

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() and, for any framer used in a while let Some(frame) loop, greater than zero: a framer that reports zero consumed bytes would hand back the same frame forever. Framers in this crate uphold both invariants. The first one is checked with a debug_assert!.

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) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Frame<'a>

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

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

Formats the value using the given formatter.

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

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

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

Equality operator ==.

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

Inequality operator !=.

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