Struct OuroBuffer 

pub struct OuroBuffer<const N: usize> { /* private fields */ }

Thread-safe circular buffer implementation

Generic Parameters

• N: Buffer capacity in bytes (must be power of two for best performance)

Implementation Details

• Uses double-check locking pattern for optimal performance
• Atomic counters for lock-free size checks
• Zero-cost initialization through const generics

Implementations

impl<const N: usize> OuroBuffer<N>

pub const fn new() -> Self

Creates a new empty buffer with zero-initialized storage

Examples

use ourobuf::OuroBuffer;

// Create 256-byte buffer
let buf = OuroBuffer::<256>::new();
assert!(buf.is_empty());

pub fn push(&self, data: &[u8]) -> Result<(), OuroBufferError>

Appends data to the buffer (thread-safe)

Parameters

• data: Byte slice to write

Errors

Returns OuroBufferError::BufferOverflow if insufficient space

Performance

• Worst-case: 2 copy operations
• Atomic operations: 2 loads, 1 store

pub fn pop(&self, output: &mut [u8]) -> usize

Reads data from buffer into mutable slice (thread-safe)

Parameters

• output: Target slice for read data

Returns

Number of bytes actually read

Performance

• Worst-case: 2 copy operations
• Atomic operations: 2 loads, 1 store

pub fn len(&self) -> usize

Returns current number of bytes in buffer (lock-free)

Performance

• Single atomic load with acquire ordering

pub fn is_empty(&self) -> bool

Checks if buffer is empty (lock-free)

Equivalent to self.len() == 0

pub fn available_space(&self) -> usize

Returns available free space in bytes (lock-free)

Calculated as capacity() - len()

pub fn clear(&self)

Resets buffer to empty state and zeros memory

Security Note

Zeroization helps prevent sensitive data leakage

Trait Implementations

impl<const N: usize> Clone for OuroBuffer<N>

fn clone(&self) -> Self

Creates a copy of current buffer state

Performance

• Full buffer copy (O(N) complexity)

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const N: usize> Debug for OuroBuffer<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.