Struct ItemQueue 

pub struct ItemQueue { /* private fields */ }

A thread-safe, multi-producer / multi-consumer queue of Items.

Cloning an ItemQueue yields another handle to the same underlying native queue, so items pushed through one clone are visible to all.

Implementations

impl ItemQueue

pub fn push(&self, item: &Item) -> Result<(), FoundryLocalError>

Push an item onto the queue, transferring a native copy into it.

pub fn try_pop(&self) -> Result<Option<Item>, FoundryLocalError>

Pop the next available item, or None if the queue is currently empty.

pub fn len(&self) -> usize

The number of items currently buffered.

pub fn is_empty(&self) -> bool

Whether the queue currently holds no items.

pub fn mark_finished(&self)

Signal that no more items will be pushed. A consumer draining the queue can then stop once it is empty.

pub fn is_finished(&self) -> bool

Whether mark_finished has been called.

Trait Implementations

impl Clone for ItemQueue

fn clone(&self) -> ItemQueue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemQueue

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

Formats the value using the given formatter.