Struct bbqueue_ng::framed::FrameGrantW

pub struct FrameGrantW<'a, const N: usize> { /* fields omitted */ }

A write grant for a single frame

NOTE: If the grant is dropped without explicitly commiting the contents without first calling to_commit(), then no frame will be comitted for writing.

Implementations

impl<'a, const N: usize> FrameGrantW<'a, { N }>

pub fn commit(self, used: usize)

Commit a frame to make it available to the Consumer half.

used is the size of the payload, in bytes, not including the frame header

pub fn to_commit(&mut self, amt: usize)

Configures the amount of bytes to be commited on drop.

Trait Implementations

impl<'a, const N: usize> Debug for FrameGrantW<'a, N>

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

Formats the value using the given formatter.

impl<'a, const N: usize> Deref for FrameGrantW<'a, { N }>

type Target = [u8]

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, const N: usize> DerefMut for FrameGrantW<'a, { N }>

pub fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.

impl<'a, const N: usize> PartialEq<FrameGrantW<'a, N>> for FrameGrantW<'a, N>

pub fn eq(&self, other: &FrameGrantW<'a, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &FrameGrantW<'a, N>) -> bool

This method tests for !=.

impl<'a, const N: usize> StructuralPartialEq for FrameGrantW<'a, N>