Struct Consumer 

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

The consumer half of the ring buffer.

Lives on the Data Plane (TPC). It is Send so it can be sent to the TPC core during setup, but once pinned to a core it stays there.

Implementations

impl<T> Consumer<T>

pub fn try_pop(&mut self) -> Result<T>

Try to dequeue a value. Returns Err(BridgeError::Empty) if the ring is empty, or Err(BridgeError::Disconnected) if the producer was dropped.

pub fn drain_into(&mut self, buf: &mut Vec<T>, max: usize) -> usize

Drain up to max items into the provided vector. Returns the count drained.

More efficient than calling try_pop in a loop because it batches the atomic tail load.

pub fn len(&self) -> usize

Returns the number of items currently in the queue.

pub fn is_empty(&self) -> bool

Returns true if the queue is empty.

pub fn metrics(&self) -> &BridgeMetrics

Returns a reference to the shared metrics.

Trait Implementations

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.