Struct work_queue::Queue

pub struct Queue<T>(_);

A work queue.

This implements Clone and so multiple handles to the queue can be easily created and shared.

Implementations

impl<T> Queue<T>

pub fn new(local_queues: usize, local_queue_size: u16) -> Self

Create a new work queue.

local_queues is the number of LocalQueues yielded by Self::local_queues. Typically you will have a local queue for each thread on a thread pool.

local_queue_size is the number of items that can be stored in each local queue before it overflows into the global one. You should fine-tune this to your needs.

Panics

This will panic if the local queue size is not a power of two.

Examples

use work_queue::Queue;

let threads = 4;
let queue: Queue<i32> = Queue::new(threads, 512);

pub fn push(&self, item: T)

Push an item to the global queue. When one of the local queues empties, they can pick this item up.

pub fn local_queues(&self) -> LocalQueues<'_, T>

Iterate over the local queues of this queue.

Panics

This will panic if called more than one time.

Trait Implementations

impl<T> Clone for Queue<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Queue<T>

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

Formats the value using the given formatter.