Struct Worker

Source

pub struct Worker<T> {
    inner: Arc<CachePadded<Inner<T>>>,
    buffer: Cell<Buffer<T>>,
    flavor: Flavor,
    _marker: PhantomData<*mut ()>,
}

Expand description

A worker queue.

This is a FIFO or LIFO queue that is owned by a single thread, but other threads may steal tasks from it. Task schedulers typically create a single worker queue per thread.

§Examples

A FIFO worker:

use crossbeam_deque::{Steal, Worker};

let w = Worker::new_fifo();
let s = w.stealer();

w.push(1);
w.push(2);
w.push(3);

assert_eq!(s.steal(), Steal::Success(1));
assert_eq!(w.pop(), Some(2));
assert_eq!(w.pop(), Some(3));

A LIFO worker:

use crossbeam_deque::{Steal, Worker};

let w = Worker::new_lifo();
let s = w.stealer();

w.push(1);
w.push(2);
w.push(3);

assert_eq!(s.steal(), Steal::Success(1));
assert_eq!(w.pop(), Some(3));
assert_eq!(w.pop(), Some(2));

Fields§

§inner: Arc<CachePadded<Inner<T>>>

A reference to the inner representation of the queue.

§buffer: Cell<Buffer<T>>

A copy of inner.buffer for quick access.

§flavor: Flavor

The flavor of the queue.

§_marker: PhantomData<*mut ()>

Indicates that the worker cannot be shared among threads.

Implementations§

Source §

impl<T> Worker<T>

Source

pub fn new_fifo() -> Worker<T>

Creates a FIFO worker queue.

Tasks are pushed and popped from opposite ends.

§Examples

use crossbeam_deque::Worker;

let w = Worker::<i32>::new_fifo();

Source

pub fn new_lifo() -> Worker<T>

Creates a LIFO worker queue.

Tasks are pushed and popped from the same end.

§Examples

use crossbeam_deque::Worker;

let w = Worker::<i32>::new_lifo();

Source

pub fn stealer(&self) -> Stealer<T>

Creates a stealer for this queue.

The returned stealer can be shared among threads and cloned.

§Examples

use crossbeam_deque::Worker;

let w = Worker::<i32>::new_lifo();
let s = w.stealer();

Source

unsafe fn resize(&self, new_cap: usize)

Resizes the internal buffer to the new capacity of new_cap.

Source

fn reserve(&self, reserve_cap: usize)

Reserves enough capacity so that reserve_cap tasks can be pushed without growing the buffer.

Source

pub fn is_empty(&self) -> bool

Returns true if the queue is empty.

use crossbeam_deque::Worker;

let w = Worker::new_lifo();

assert!(w.is_empty());
w.push(1);
assert!(!w.is_empty());

Source

pub fn len(&self) -> usize

Returns the number of tasks in the deque.

use crossbeam_deque::Worker;

let w = Worker::new_lifo();

assert_eq!(w.len(), 0);
w.push(1);
assert_eq!(w.len(), 1);
w.push(1);
assert_eq!(w.len(), 2);

Source

pub fn push(&self, task: T)

Pushes a task into the queue.

§Examples

use crossbeam_deque::Worker;

let w = Worker::new_lifo();
w.push(1);
w.push(2);

Source

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

Pops a task from the queue.

§Examples

use crossbeam_deque::Worker;

let w = Worker::new_fifo();
w.push(1);
w.push(2);

assert_eq!(w.pop(), Some(1));
assert_eq!(w.pop(), Some(2));
assert_eq!(w.pop(), None);