Struct Consumer 

pub struct Consumer<T, PO: Output + 'static, B> { /* private fields */ }

A consumer of items from the queue

Implementations

impl<T, PO: Output + 'static> Consumer<T, PO, SingleBarrier<PO>>

pub fn new( ring: Arc<RingBuffer<T, PO>>, mode: ConsumerMode, ) -> Result<Self, TooManyConsumers>

Creates a new consumer that await for messages from all producers on a ring

Errors

Fail when the ring reached the maximum number of consumers

impl<T, PO: Output + 'static> Consumer<T, PO, SingleBarrier<OwnedOutput>>

pub fn new_awaiting_on<U: QueueUser<Item = T, UserOutput = OwnedOutput, ProducerOutput = PO>>( other: &U, mode: ConsumerMode, ) -> Result<Self, TooManyConsumers>

Creates a new consumer that awaits on a single other user, usually a consumer

Errors

Fail when the ring reached the maximum number of consumers

impl<T, PO: Output + 'static> Consumer<T, PO, MultiBarrier<OwnedOutput>>

pub fn new_awaiting_multiple<'u, I>( others: I, mode: ConsumerMode, ) -> Result<Self, TooManyConsumers>

where I: IntoIterator<Item = &'u dyn QueueUser<Item = T, UserOutput = OwnedOutput, ProducerOutput = PO>>, T: 'u,

Creates a new consumer that awaits on multiple other users, usually consumers

Errors

Fail when the ring reached the maximum number of consumers

impl<T, PO: Output + 'static, B> Consumer<T, PO, B>

pub fn blocking_mode(&self) -> ConsumerMode

Whether this consumer blocks producers By default, consumers block producers writing new items when they have not yet be seen. Setting a consumer as non-blocking enable producers to write event though the consumer may be lagging.

impl<T, PO: Output + 'static, B: Barrier> Consumer<T, PO, B>

pub fn get_number_of_items(&self) -> usize

Gets the number of items in the queue accessible to this consumer

pub fn try_recv(&mut self) -> Result<ConsumerAccess<'_, T, PO, B>, TryRecvError>

Attempts to receive available items from the queue

Errors

This returns a TryRecvError when the queue is empty, or when there is no longer any producer

pub fn try_recv_bounded( &mut self, max: usize, ) -> Result<ConsumerAccess<'_, T, PO, B>, TryRecvError>

Attempts to receive available items from the queue with a maximum number of items

Errors

This returns a TryRecvError when the queue is empty, or when there is no longer any producer

pub fn try_recv_copies( &mut self, buffer: &mut [T], ) -> Result<usize, TryRecvError>

where T: Copy,

Attempts to receive a single item from the queue

Errors

This returns a TryRecvError when the queue is empty, or when there is no longer any producer

Trait Implementations

impl<T, PO: Output + 'static, B: Clone> Clone for Consumer<T, PO, B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, PO: Debug + Output + 'static, B: Debug> Debug for Consumer<T, PO, B>

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

Formats the value using the given formatter.

impl<T, PO: Output + 'static, B> Drop for Consumer<T, PO, B>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, PO: Output + 'static, B> QueueUser for Consumer<T, PO, B>

type Item = T

The type of the queue items

type UserOutput = OwnedOutput

The type of output for this user

type ProducerOutput = PO

The type for the producer’s output

fn queue(&self) -> &Arc<RingBuffer<Self::Item, Self::ProducerOutput>>

Gets the queue itself

fn output(&self) -> &Arc<Self::UserOutput>

Gets the output that can be awaited on for items that are available after this user