Struct WorkQueue 

pub struct WorkQueue { /* private fields */ }

Work queue for deferred tasks.

Thread-safe, FIFO queue with bounded capacity. When the queue is full, new tasks are dropped and the overflow counter is incremented.

Thread Safety

The queue uses a Mutex<VecDeque<Task>> internally, making it safe to push from multiple threads. However, heavy contention should be avoided for performance.

Implementations

impl WorkQueue

pub fn new() -> Self

Create a new work queue with default capacity.

pub fn with_capacity(capacity: usize) -> Self

Create a work queue with specified capacity.

Capacity is clamped to MAX_CAPACITY.

pub fn push(&self, task: Task) -> bool

Push a task to the queue.

Returns true if the task was queued, false if dropped due to overflow. This is non-blocking - overflow tasks are immediately dropped.

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

Try to pop a task from the queue.

Returns None if the queue is empty.

pub fn drain(&self) -> Vec<Task>

Drain all tasks from the queue.

Returns all pending tasks, leaving the queue empty.

pub fn process_pending(&self, limit: usize) -> usize

Process up to limit pending tasks.

Pops and executes tasks in order. Returns the number of tasks successfully executed. Tasks that fail or panic are counted but not returned.

pub fn len(&self) -> usize

Get the number of pending tasks.

Note: This is a snapshot and may change immediately after returning.

pub fn is_empty(&self) -> bool

Check if the queue is empty.

Note: This is a snapshot and may change immediately after returning.

pub const fn capacity(&self) -> usize

Get the queue capacity.

pub fn dropped_count(&self) -> usize

Get the number of dropped tasks (overflow).

This count accumulates over the lifetime of the queue.

pub fn clear(&self) -> usize

Clear all pending tasks without executing them.

Returns the number of tasks cleared.

Trait Implementations

impl Debug for WorkQueue

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

Formats the value using the given formatter.

impl Default for WorkQueue

fn default() -> Self

Returns the “default value” for a type.