Struct PriorityQueue

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

An async-aware priority queue.

Implementations

impl<T: Ord> PriorityQueue<T>

pub fn new() -> Self

pub fn push(&self, item: T)

Pushes an item into the queue. It will be removed in an order consistent with the ordering of itself relative to other items in the queue at the time of removal.

pub fn try_pop(&self) -> Option<T>

Attempts to remove the item with the highest priority from the queue, returning None if there are no available items.

pub fn pop(&self) -> PopFut<'_, T>

Removes the item with the highest priority from the queue, waiting for an item should there not be one immediately available.

Items are removed from the queue on a ‘first come, first served’ basis.

pub fn incoming(&self) -> IncomingStream<'_, T>

Returns a stream of highest-priority items from this queue.

Items are removed from the queue on a ‘first come, first served’ basis.

pub fn pending(&self) -> impl Iterator<Item = T> + '_

Returns an iterator of pending items from the queue (i.e: those that have already been inserted). Items will only be removed from the queue as the iterator is advanced.

pub fn drain(&self) -> impl ExactSizeIterator<Item = T> + FusedIterator

Returns an iterator of items currently occupying the queue, immediately draining the queue.

pub fn len(&self) -> usize

Return the number of items currently occupying the priority queue.

Because the queue is asynchronous, this information should be considered out of date immediately and, as such, should only be used for the purpose of logging, heuristics, etc.

pub fn is_empty(&self) -> bool

Return true if the priority queue is currently empty.

Because the queue is asynchronous, this information should be considered out of date immediately and, as such, should only be used for the purpose of logging, heuristics, etc.

Trait Implementations

impl<T: Ord> Default for PriorityQueue<T>

fn default() -> Self

Returns the “default value” for a type.