Struct lock_free_multi_producer_single_consumer_ring_buffer::RingBufferConsumer

pub struct RingBufferConsumer<T: Sized>(_);

A ring buffer consumer for receiving lock-less bursts of messages.

Not particularly cheap to consume from (as it walks all producers) so try to use as few producers as possible and consume as much as possible with each call.

Methods

impl<T: Sized> RingBufferConsumer<T>

Important traits for RingBufferConsumerGuard<'a, T>

impl<'a, T: 'a + Sized> Iterator for RingBufferConsumerGuard<'a, T> type Item = T;

pub fn consume<'a>(&'a self) -> RingBufferConsumerGuard<'a, T>

Get a contiguous range which is ready to be consumed.

Only call this on one thread at a time.

Not particularly cheap (as it walks all producers) so try to take as much as possible.

Trait Implementations

impl<T: Eq + Sized> Eq for RingBufferConsumer<T>

impl<T: PartialOrd + Sized> PartialOrd<RingBufferConsumer<T>> for RingBufferConsumer<T>

fn partial_cmp(&self, other: &RingBufferConsumer<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &RingBufferConsumer<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &RingBufferConsumer<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &RingBufferConsumer<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &RingBufferConsumer<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialEq + Sized> PartialEq<RingBufferConsumer<T>> for RingBufferConsumer<T>

fn eq(&self, other: &RingBufferConsumer<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RingBufferConsumer<T>) -> bool

This method tests for !=.

impl<T: Ord + Sized> Ord for RingBufferConsumer<T>

fn cmp(&self, other: &RingBufferConsumer<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<T: Debug + Sized> Debug for RingBufferConsumer<T>

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

Formats the value using the given formatter.