Struct CBuf 

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

Bounded SPSC ring queue.

CBuf mirrors the contract of the C CBUF_* macro family while remaining safe to use across multiple producers or consumers (the underlying ArrayQueue is MPMC). A new ring of capacity N admits up to N elements before push starts returning Err.

Implementations

impl<T> CBuf<T>

pub fn new(capacity: usize) -> Self

Create a ring with room for exactly capacity elements.

Panics

Panics if capacity == 0 (matching the precondition on ArrayQueue::new).

Examples

use dynomite::io::cbuf::CBuf;
let q: CBuf<u8> = CBuf::new(8);
assert_eq!(q.capacity(), 8);

pub fn capacity(&self) -> usize

Capacity in elements. Mirrors cbuf##_SIZE.

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

Append an element. Returns Err(item) when the ring is full, echoing try_send on bounded channels. Mirrors CBUF_Push (the C version overwrites silently on overflow; the Rust version reports the failure so callers cannot lose data inadvertently).

Examples

use dynomite::io::cbuf::CBuf;
let q: CBuf<u8> = CBuf::new(2);
q.push(1).unwrap();
q.push(2).unwrap();
assert_eq!(q.push(3), Err(3));

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

Remove and return the head element. Mirrors CBUF_Pop.

Examples

use dynomite::io::cbuf::CBuf;
let q: CBuf<u8> = CBuf::new(2);
q.push(7).unwrap();
assert_eq!(q.pop(), Some(7));
assert_eq!(q.pop(), None);

pub fn len(&self) -> usize

Number of elements currently buffered. Mirrors CBUF_Len.

pub fn is_empty(&self) -> bool

True when the ring contains no elements. Mirrors CBUF_IsEmpty.

pub fn is_full(&self) -> bool

True when the ring is at capacity. Mirrors CBUF_IsFull.

Trait Implementations

impl<T> Debug for CBuf<T>

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

Formats the value using the given formatter.