Struct dfqueue::DFQueueConsumer

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

A consumer that can process (peek into) elements in a DFQueue, but not actually remove them. Do not wrap this in an Arc or Mutex, the queue it is already protected by those on the interior.

This does not provide a pop() method like most queues, because we do not permit the consumer to directly remove items from the queue. Instead, we require that an element can only be removed from the queue once it has been marked complete, providing a sort of transactional behavior.

Implementations

impl<T> DFQueueConsumer<T>

pub fn obtain_producer(&self) -> DFQueueProducer<T>

Returns a new DFQueueProducer cloned from this consumer instance, since there can be multiple producers.

pub fn peek(&self) -> Option<PeekedData<T>>

Returns the next non-completed element in the queue without actually removing it from the queue, or None if the queue is empty or in a temporarily-inconsistent state.

Trait Implementations

impl<T: Debug> Debug for DFQueueConsumer<T>

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

Formats the value using the given formatter.