Struct Receiver 

pub struct Receiver<T> { /* private fields */ }

A receiver endpoint for a VMO-backed FIFO queue.

Implementations

impl<T: FromBytes + IntoBytes + KnownLayout + Copy> Receiver<T>

pub fn new(vmo: Vmo, capacity: u32) -> Result<Self, Status>

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> u32

pub fn index(&self) -> u64

pub fn vmo(&self) -> &Vmo

pub fn pop_reserve(&mut self) -> Result<T, Status>

Fetches the next message without incrementing the read index.

pub fn pop_commit(&mut self) -> Result<(), Status>

Commit the read, freeing the slot.

pub fn payload_slice(&self, vmo_offset: u32, len: u32) -> PtrByteSlice<'_>

Returns a raw slice pointer to the specified payload region.

Panics

Panics if the vmo_offset + len exceeds the bounds of the VMO.

impl<T> Receiver<T>

pub fn shutdown(&self) -> Result<(), Status>

Trait Implementations

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.