Struct lock_free_multi_producer_single_consumer_ring_buffer::RingBuffer

pub struct RingBuffer<T: Copy> { /* fields omitted */ }

A ring buffer for sending 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.

Multi-Producer, Single-Consumer (MP-SC).

Methods

impl<T: Copy> RingBuffer<T>

pub fn new(     capacity: usize,     number_of_producers: usize ) -> (RingBufferConsumer<T>, Vec<RingBufferProducer<T>>)

Creates a new ring buffer and returns a consumer to it and producers for it.

When the last consumer or producer is dropped, the ring buffer is freed.

Trait Implementations

impl<T: Eq + Copy> Eq for RingBuffer<T>

impl<T: PartialOrd + Copy> PartialOrd<RingBuffer<T>> for RingBuffer<T>

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

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

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

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

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

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

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

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

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

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

impl<T: PartialEq + Copy> PartialEq<RingBuffer<T>> for RingBuffer<T>

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

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

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

This method tests for !=.

impl<T: Clone + Copy> Clone for RingBuffer<T>

fn clone(&self) -> RingBuffer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord + Copy> Ord for RingBuffer<T>

fn cmp(&self, other: &RingBuffer<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 + Copy> Debug for RingBuffer<T>

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

Formats the value using the given formatter.