Struct syscall::io_uring::v1::SpscReceiver

pub struct SpscReceiver<T> { /* fields omitted */ }

A safe wrapper over the raw Ring interface, that takes care of the mmap offset, as well as the global Ring structure. Only allows receiving items.

The wrapper is Send, and can thus be transferred between threads. However, it is [!Sync], since it does not take multiple atomic receivers into account. Thus, it will have to be wrapped in something like a mutex if that is necessary.

Implementations

impl<T> SpscReceiver<T>

pub unsafe fn from_raw(ring: *const Ring<T>, entries_base: *const T) -> Self

pub fn try_recv(&self) -> Result<T, RingPopError>

pub fn spin_on_recv(&self) -> Result<T, RingRecvError>

pub fn try_iter(&self) -> impl Iterator<Item = T> + '_

pub fn deallocate(self) -> Result<()>

pub unsafe fn ring_header(&self) -> &Ring<T>

Retrieve the ring header, which stores head and tail pointers, and epochs.

Safety

Unsafe for the same reasons as with SpscSender.

Trait Implementations

impl<T> Drop for SpscReceiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for SpscReceiver<T>