Struct syscall::io_uring::v1::SpscSender

pub struct SpscSender<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 sending items.

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

Implementations

impl<T> SpscSender<T>

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

pub fn try_send(&self, item: T) -> Result<(), RingPushError<T>>

pub fn spin_on_send(&self, item: T) -> Result<(), RingSendError<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

This is unsafe because it allows arbitrarily changing the head and tail pointers (indices). While the only allowed entries thus far have a valid repr, and thus allow any bytes to be reinterpreted, this can produce invalid commands that may corrupt the memory of the current process.

pub fn notify(&self)

Wake the receiver up if it was blocking on a new message, without sending anything. This is useful when building a core::future::Future executor, for the core::task::Waker.

Trait Implementations

impl<T> Drop for SpscSender<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for SpscSender<T>