Struct Consumer 

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

Receiving half. Send but not Sync.

Implementations

impl<T> Consumer<T>

pub fn ring_addr(&self) -> usize

Address of the underlying ring allocation. Two producers or consumers sharing the same ring return the same value.

impl<T> Consumer<T>

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

Pop one item. Zero atomics; reads from the prefetched window. Returns None when the prefetched window is exhausted. Call prefetch to load newly flushed items and release to publish consumed slots back to the producer.

pub fn release(&mut self)

Publish consumed position so the producer can reuse slots. One Release store. Call after draining a batch of pops.

pub fn prefetch(&mut self) -> usize

Load all items flushed since the last prefetch. One Acquire load. Returns the count of newly available items.

pub fn prefetch_and_pop(&mut self) -> Option<T>

Convenience: prefetch + pop + release. For callers that don’t need batching.

pub fn is_empty(&self) -> bool

pub fn is_disconnected(&self) -> bool

The producer has been dropped and all flushed items have been consumed. No more data will ever arrive.

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn close(&mut self)

Mark the consumer side closed and release consumed slots.

This is normally called by Drop. Calling it explicitly is useful for wrappers that need to wake a producer after marking the consumer as gone. After calling this, the consumer should not be used again.

Trait Implementations

impl<T> Debug for Consumer<T>

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

Formats the value using the given formatter.

impl<T> Drop for Consumer<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: Send> Send for Consumer<T>