Struct SpscRing 

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

A wait-free SPSC ring buffer in a shared memory region.

This is a convenience wrapper around SpscRingRaw<T> that manages memory through a Region. All operations delegate to the raw implementation.

Implementations

impl<T: Copy> SpscRing<T>

pub unsafe fn init(region: Region, header_offset: usize, capacity: u32) -> Self

Initialize a new ring in the region.

Safety

The region must be writable and exclusively owned during initialization.

pub unsafe fn attach(region: Region, header_offset: usize) -> Self

Attach to an existing ring in the region.

Safety

The region must contain a valid, initialized ring header.

pub fn inner(&self) -> &SpscRingRaw<T>

Get a reference to the inner raw ring.

pub fn split(&self) -> (SpscProducer<'_, T>, SpscConsumer<'_, T>)

Split into producer and consumer handles.

pub fn capacity(&self) -> u32

Returns the ring capacity.

pub fn is_empty(&self) -> bool

Returns true if the ring appears empty.

pub fn status(&self) -> RingStatus

Returns a status snapshot of head/tail.

Trait Implementations

impl<T: Send> Send for SpscRing<T>

impl<T: Send> Sync for SpscRing<T>