Struct WorkQueue 

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

A bounded, priority-ordered work queue.

Items are stored in a Vec sorted in ascending priority order so that the highest-priority item is always at the back and can be removed in O(1). Pushes maintain sorted order via binary search insertion at O(n) in the worst case, which is acceptable for the typical small queue sizes used in media pipeline scheduling.

Examples

use oximedia_core::work_queue::{WorkItem, WorkQueue};

let mut q: WorkQueue<i32> = WorkQueue::new(4);
q.push(WorkItem::new(1, 5)).expect("queue not full");
q.push(WorkItem::new(2, 1)).expect("queue not full");
q.push(WorkItem::new(3, 9)).expect("queue not full");
assert_eq!(q.pop().expect("queue not empty").payload, 3); // priority 9 first
assert_eq!(q.len(), 2);

Implementations

impl<T> WorkQueue<T>

pub fn new(capacity: usize) -> Self

Creates a new queue with the given maximum capacity.

Panics

Panics if capacity is zero.

pub const fn capacity(&self) -> usize

Returns the maximum number of items this queue can hold.

pub fn len(&self) -> usize

Returns the current number of items in the queue.

pub fn is_empty(&self) -> bool

Returns true if the queue contains no items.

pub fn is_full(&self) -> bool

Returns true if the queue has reached its capacity.

pub fn push(&mut self, item: WorkItem<T>) -> Result<(), QueueError>

Pushes a work item into the queue in priority order.

Errors

Returns QueueError::Full if the queue is at capacity.

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

Removes and returns the highest-priority item, or None if empty.

pub fn pop_batch(&mut self, n: usize) -> Result<Vec<WorkItem<T>>, QueueError>

Removes and returns up to n highest-priority items.

Errors

Returns QueueError::BatchTooLarge if n > capacity.

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

Peeks at the highest-priority item without removing it.

pub fn clear(&mut self)

Removes all items from the queue (statistics are preserved).

pub fn stats(&self) -> QueueStats

Returns a snapshot of the lifetime statistics.

pub fn iter(&self) -> impl Iterator<Item = &WorkItem<T>>

Returns an iterator over all items in ascending priority order.

Trait Implementations

impl<T: Debug> Debug for WorkQueue<T>

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

Formats the value using the given formatter.