Skip to main content

SpscVarQueue

Struct SpscVarQueue 

Source
pub struct SpscVarQueue { /* private fields */ }
Expand description

Single-producer single-consumer variable-length lock-free ring queue.

The underlying storage uses MaybeUninit<u64> as raw byte blocks instead of [MessageHeader; N]. This allows subsequent blocks to be safely used as raw payload byte regions without overwriting initialized MessageHeader/AtomicU32 objects with invalid values.

Implementations§

Source§

impl SpscVarQueue

Source

pub unsafe fn producer_alloc( this: *mut Self, size: u32, ) -> Option<*mut MessageHeader>

Allocates space on the producer side (called only by the writer thread).

§Safety

Must be called via a raw pointer, and only the writer thread may call this method.

Source

pub unsafe fn consumer_front(this: *const Self) -> Option<*const MessageHeader>

Peeks at the front message on the consumer side (called only by the background thread). This only observes the message without advancing read_index.

§Safety

Must be called via a raw pointer, and only the reader thread may call this method.

Source

pub unsafe fn consumer_pop(this: *mut Self)

Pops the front message on the consumer side (called only by the background thread).

§Safety

Must be called only after consumer_front has returned Some.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.