SpscQueue

Struct SpscQueue 

Source
pub struct SpscQueue {
    buffer: Vec<Mutex<Option<MessageEnvelope>>>,
    capacity: usize,
    mask: usize,
    head: AtomicU64,
    tail: AtomicU64,
    stats: QueueStatsInner,
}
Expand description

Single-producer single-consumer lock-free ring buffer.

This implementation is optimized for the common case of one producer (host) and one consumer (GPU kernel).

Fields§

§buffer: Vec<Mutex<Option<MessageEnvelope>>>

Ring buffer storage.

§capacity: usize

Capacity (power of 2).

§mask: usize

Mask for index wrapping.

§head: AtomicU64

Head pointer (producer writes here).

§tail: AtomicU64

Tail pointer (consumer reads from here).

§stats: QueueStatsInner

Statistics.

Implementations§

Source§

impl SpscQueue

Source

pub fn new(capacity: usize) -> Self

Create a new queue with the given capacity.

Capacity will be rounded up to the next power of 2.

Source

fn depth(&self) -> u64

Get current depth.

Source

fn update_max_depth(&self)

Update max depth statistic.

Trait Implementations§

Source§

impl MessageQueue for SpscQueue

Source§

fn capacity(&self) -> usize

Get the queue capacity.
Source§

fn len(&self) -> usize

Get current queue size.
Source§

fn try_enqueue(&self, envelope: MessageEnvelope) -> Result<()>

Try to enqueue a message envelope.
Source§

fn try_dequeue(&self) -> Result<MessageEnvelope>

Try to dequeue a message envelope.
Source§

fn stats(&self) -> QueueStats

Get queue statistics.
Source§

fn reset_stats(&self)

Reset queue statistics.
Source§

fn is_empty(&self) -> bool

Check if queue is empty.
Source§

fn is_full(&self) -> bool

Check if queue is full.

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V