Struct BucketQueue

pub struct BucketQueue<T, const N: usize> { /* private fields */ }

A priority queue using a circular array of buckets for priorities within a sliding window.

New items must have a priority within current_priority..current_priority + N. current_priority is only updated on pop and when the first item is pushed.

Items are popped in LIFO order within each priority bucket as Vec is used internally to avoid the extra overhead of VecDeque.

Example

let mut queue = BucketQueue::<i32, 8>::new();
queue.push(0, 100);
queue.push(2, 200);
queue.push(7, 400);
queue.push(2, 300);
assert_eq!(queue.pop(), Some(100));
assert_eq!(queue.pop(), Some(300));
assert_eq!(queue.pop(), Some(200));
assert_eq!(queue.peek(), Some(&400));
assert_eq!(queue.peek_entry(), Some((7, &400)));
assert_eq!(queue.pop_entry(), Some((7, 400)));
assert_eq!(queue.pop(), None);
assert_eq!(queue.peek(), None);

Implementations

impl<T, const N: usize> BucketQueue<T, N>

pub fn new() -> Self

pub fn with_capacity(per_bucket_capacity: usize) -> Self

pub fn push(&mut self, priority: usize, value: T)

pub fn pop(&mut self) -> Option<T>

pub fn pop_entry(&mut self) -> Option<(usize, T)>

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

pub fn peek_entry(&self) -> Option<(usize, &T)>

pub fn clear(&mut self)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl<T: Clone, const N: usize> Clone for BucketQueue<T, N>

fn clone(&self) -> BucketQueue<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for BucketQueue<T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Default for BucketQueue<T, N>

fn default() -> Self

Returns the “default value” for a type.