Struct lock_free_multi_producer_single_consumer_ring_buffer::RingBufferProducer

pub struct RingBufferProducer<T: Sized> { /* fields omitted */ }

Produces bursts of messages to put into the ring buffer.

Methods

impl<T: Sized> RingBufferProducer<T>

pub fn acquire<'a>(     &'a self,     count: usize ) -> Result<RingBufferProducerGuard<'a, T>, ()>

Request a space of a given count in the ring buffer.

Returns a slice offset into the (external) ring buffer for which count bytes are available.

Should be released with produce().

Slice data should be treated as uninitialized, not necessarily zero'd.

• count should not be zero.
• count should not exceed the buffer size.

Returns an Err if the producer could acquire a slice of the desired count.

pub fn repeatedly_acquire_and_try_to_populate(&self, populate_with: &mut Vec<T>)

A wrapper around acquire, that retries progressively smaller counts if acquire fails, eventually reducing to a count of 1 before giving up.

If it gives up, there will be values remaining in populate_with on return.

All the other original values in populate_with are moved into the ring buffer (and so are not dropped).

populate_with can have a .len() of zero.

Trait Implementations

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

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

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

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

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

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

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

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

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

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

fn ge(&self, other: &RingBufferProducer<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<RingBufferProducer<T>> for RingBufferProducer<T>

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

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

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

This method tests for !=.

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

fn cmp(&self, other: &RingBufferProducer<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 RingBufferProducer<T>

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

Formats the value using the given formatter.