Struct queue_queue::rusty::RustyPriorityQueue

pub struct RustyPriorityQueue<P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> { /* private fields */ }

A priority queue implementation based on Rust’s BinaryHeap. Templated with P for priority and T for data.

• P must be PartialOrd, PartialEq, and Eq.
• T must be PartialEq and Eq.

If Node A and Node B have the same priority, but Node A was added before Node B, then Node A will be prioritized over Node B. See PriorityQueue for more information.

Examples

let mut prio = RustyPriorityQueue::<usize, String>::default();
prio.enqueue(2, "hello".to_string());
prio.enqueue(3, "julia".to_string());
prio.enqueue(1, "world".to_string());
prio.enqueue(3, "naomi".to_string());

let mut new_prio: RustyPriorityQueue<usize, String> = prio
    .into_iter()
    .map(|(priority, data)| (priority, data.to_owned() + " wow"))
    .collect();

assert_eq!(new_prio.dequeue(), Some((3, "julia wow".to_string())));
assert_eq!(new_prio.dequeue(), Some((3, "naomi wow".to_string())));
assert_eq!(new_prio.dequeue(), Some((2, "hello wow".to_string())));
assert_eq!(new_prio.dequeue(), Some((1, "world wow".to_string())));

Implementations

impl<P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> RustyPriorityQueue<P, T>

pub const fn iter(&self) -> RustyPriorityQueueIterator<'_, P, T>

Get an iterator over the priority queue

pub fn into_iter(self) -> RustyPriorityQueueIntoIterator<P, T>

Convert the priority queue into an iterator

Trait Implementations

impl<P: Debug + PartialOrd + PartialEq + Eq, T: Debug + PartialEq + Eq> Debug for RustyPriorityQueue<P, T>

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

Formats the value using the given formatter.

impl<P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> Default for RustyPriorityQueue<P, T>

fn default() -> Self

Returns the “default value” for a type.

impl<P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> FromIterator<(P, T)> for RustyPriorityQueue<P, T>

fn from_iter<I: IntoIterator<Item = (P, T)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'b, P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> IntoIterator for &'b RustyPriorityQueue<P, T>

type IntoIter = RustyPriorityQueueIterator<'b, P, T>

Which kind of iterator are we turning this into?

type Item = (&'b P, &'b T)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> IntoIterator for RustyPriorityQueue<P, T>

type Item = (P, T)

The type of the elements being iterated over.

type IntoIter = RustyPriorityQueueIntoIterator<P, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<P: PartialOrd + PartialEq + Eq, T: PartialEq + Eq> PriorityQueue<P, T> for RustyPriorityQueue<P, T>

fn enqueue(&mut self, priority: P, data: T)

Add an item to the queue

fn dequeue(&mut self) -> Option<(P, T)>

Remove an item from the queue

fn peek(&self) -> Option<(&P, &T)>

Peeks the next item in the queue

fn len(&self) -> usize

Queue length

fn is_empty(&self) -> bool

Bollean if the queue is empty