Struct WorkQueue 

pub struct WorkQueue<T: Send + 'static> { /* private fields */ }

Bounded, multi-producer work queue (sending half).

Items sent to a WorkQueue may be received by exactly one WorkReceiver. The queue is backed by std::sync::mpsc::sync_channel, providing natural backpressure: blocking push waits until a slot is free; non-blocking try_push returns Ok(false) when the queue is at capacity.

Clone behaviour

Cloning a WorkQueue creates an additional sender to the same channel — multiple threads may push concurrently.

Example

use scirs2_core::distributed::primitives::WorkQueue;

let (queue, receiver) = WorkQueue::<i32>::new(8).expect("queue creation failed");
queue.push(42).expect("push failed");
let item = receiver.recv().expect("recv returned None");
assert_eq!(item, 42);

Implementations

impl<T: Send + 'static> WorkQueue<T>

pub fn new(capacity: usize) -> Result<(Self, WorkReceiver<T>), DistributedError>

Create a new bounded work queue with the given capacity.

Returns (WorkQueue, WorkReceiver) on success.

Errors

DistributedError::InvalidArgument when capacity == 0.

pub fn push(&self, task: T) -> Result<(), DistributedError>

Blocking push. Waits until a slot is available.

Errors

DistributedError::Disconnected if the WorkReceiver has been dropped.

pub fn try_push(&self, task: T) -> Result<bool, DistributedError>

Non-blocking push.

Returns:

• Ok(true) — the task was enqueued successfully.
• Ok(false) — the queue was full; the task was not enqueued.

Errors

DistributedError::Disconnected if the WorkReceiver has been dropped.

pub fn len(&self) -> usize

Approximate number of items currently in the queue.

pub fn is_empty(&self) -> bool

Returns true if the queue contains no items.

pub fn capacity(&self) -> usize

Maximum capacity of this queue.

Trait Implementations

impl<T: Clone + Send + 'static> Clone for WorkQueue<T>

fn clone(&self) -> WorkQueue<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Send + 'static> Debug for WorkQueue<T>

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

Formats the value using the given formatter.