Struct VibeQueue 

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

A bounded, thread-safe queue for holding tasks.

VibeQueue is used within each VibeNode to buffer incoming tasks. It sends NodeOverloaded and NodeIdle signals to the system when its size crosses defined percentage thresholds (watermarks).

Implementations

impl<T> VibeQueue<T>

pub fn len(&self) -> usize

Returns the current number of items in the queue.

pub fn capacity(&self) -> usize

Returns the maximum capacity of 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 maximum capacity.

pub fn id(&self) -> QueueId

Returns the unique ID of this queue.

pub fn close(&self)

Closes the queue, preventing any new items from being added.

Items already in the queue can still be removed.

pub fn is_closed(&self) -> bool

Returns true if the queue has been closed.

impl VibeQueue<Task>

pub fn with_watermarks_and_signal( node_id: NodeId, capacity: usize, low_watermark_percentage: f32, high_watermark_percentage: f32, signal_tx: Sender<SystemSignal>, ) -> Self

Creates a new VibeQueue with custom watermarks for signaling.

Panics

Panics if capacity is 0 or if watermark percentages are invalid.

pub fn new_with_signal( node_id: NodeId, capacity: usize, signal_tx: Sender<SystemSignal>, ) -> Self

Creates a new VibeQueue with default watermarks (25% and 75%).

pub fn enqueue(&self, task: Task) -> Result<(), QueueError>

Adds a task to the back of the queue.

If adding the task causes the queue to become full, it sends a NodeOverloaded signal.

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

Removes a task from the front of the queue.

If removing the task causes a previously overloaded queue to drop below its low watermark, it sends a NodeIdle signal.

Trait Implementations

impl<T> Clone for VibeQueue<T>

fn clone(&self) -> Self

Clones the queue.

This is a cheap operation, as it only clones the Arc pointers to the underlying queue data, not the data itself.

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

Performs copy-assignment from source.

impl<T> Debug for VibeQueue<T>

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

Formats the value using the given formatter.