Struct LockFreeRingBuffer 

pub struct LockFreeRingBuffer<T: Copy + Send + 'static> { /* private fields */ }

Lock-free SPSC ring buffer with power-of-2 capacity.

Internally stores items in a fixed-size boxed slice of UnsafeCell<MaybeUninit<T>>. Two atomic counters (head for the write position and tail for the read position) are advanced using Acquire/Release ordering so that item writes are visible to the reader thread before the head index update becomes visible.

Capacity rounding

The requested capacity is rounded up to the next power of two so that index & mask can replace index % capacity.

Example

use trustformers_debug::ring_buffer::LockFreeRingBuffer;

let buf = LockFreeRingBuffer::<i32>::new(6);
// Rounded up to the next power of 2 → 8
assert_eq!(buf.capacity(), 8);

assert!(buf.push(1).is_ok());
assert_eq!(buf.pop(), Some(1));
assert_eq!(buf.pop(), None);

Implementations

impl<T: Copy + Send + 'static> LockFreeRingBuffer<T>

pub fn new(capacity: usize) -> Self

Creates a new buffer whose actual capacity is the smallest power of 2 that is >= capacity.

Panics

Panics if capacity is 0.

Example

use trustformers_debug::ring_buffer::LockFreeRingBuffer;
let buf = LockFreeRingBuffer::<u8>::new(10);
assert_eq!(buf.capacity(), 16); // rounded up to next power of 2

pub fn push(&self, item: T) -> Result<(), RingBufferError>

Attempts to push item into the buffer.

Returns Err(RingBufferError::Full { … }) if the buffer is full.

Example

use trustformers_debug::ring_buffer::{LockFreeRingBuffer, RingBufferError};

let buf = LockFreeRingBuffer::<u8>::new(2);
assert!(buf.push(10).is_ok());
assert!(buf.push(20).is_ok());
let err = buf.push(30).unwrap_err();
assert!(matches!(err, RingBufferError::Full { .. }));

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

Attempts to pop an item from the buffer.

Returns None if the buffer is empty.

Example

use trustformers_debug::ring_buffer::LockFreeRingBuffer;

let buf = LockFreeRingBuffer::<u8>::new(4);
assert_eq!(buf.pop(), None);
buf.push(99).unwrap();
assert_eq!(buf.pop(), Some(99));
assert_eq!(buf.pop(), None);

pub fn len(&self) -> usize

Returns the number of items currently held in the buffer.

Note: this is a point-in-time snapshot; the value may change concurrently.

pub fn is_empty(&self) -> bool

Returns true if the buffer currently holds no items.

pub fn capacity(&self) -> usize

Returns the (rounded-up) capacity.

Trait Implementations

impl<T: Copy + Send + 'static> Send for LockFreeRingBuffer<T>

impl<T: Copy + Send + 'static> Sync for LockFreeRingBuffer<T>