Struct RingBuffer 

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

Lock-free single-producer / single-consumer ring buffer backed by a fixed array in shared memory.

T must be Copy so that reads/writes are safe without destructors. The capacity must be a power of two so that modulo can be done with a mask.

Implementations

impl<T> RingBuffer<T>

where T: Copy,

pub unsafe fn new( buffer: *mut T, write_idx: *mut Atomic<u32>, read_idx: *mut Atomic<u32>, capacity: usize, ) -> RingBuffer<T>

Safety

buffer must point to capacity valid, initialized slots. write_idx and read_idx must point to distinct AtomicU32s. capacity must be a power of two.

pub fn push(&self, event: T) -> bool

Attempt to push a single event. Returns true on success, false if the buffer is full.

pub fn pop(&self) -> Option<T>

Pop a single event. Returns None if the buffer is empty.

pub fn len(&self) -> usize

Returns the number of readable slots.

pub fn is_empty(&self) -> bool

Trait Implementations

impl<T> Send for RingBuffer<T>

where T: Send,

impl<T> Sync for RingBuffer<T>

where T: Sync,