Struct Frame

pub struct Frame { /* private fields */ }

Wraps a static mutable byte slice along with header information for a payload.

This enables the user to abdicate any concerns about where the payload should be placed in the buffer.

Implementations

impl Frame

pub fn into_buf(self) -> &'static mut [u8]

Consumes the frame and retrieves the buffer it wraps

pub fn remaining_data_capacity(&self) -> usize

Calculates how much more data this frame can hold

pub fn append_payload(&mut self, payload: &[u8]) -> Result<(), ErrorCode>

Appends payload bytes into the frame if possible

pub fn append_payload_process( &mut self, payload_buf: &ReadableProcessSlice, ) -> Result<(), ErrorCode>

Appends payload bytes from a process slice into the frame if possible

Trait Implementations

impl Debug for Frame

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

Formats the value using the given formatter.

impl PartialEq for Frame

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

impl StructuralPartialEq for Frame