Struct Worker

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

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));

Implementations

impl<T> Worker<T>

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();

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();

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();

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());

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);

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);

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);

Trait Implementations

impl<T> Debug for Worker<T>

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

impl<T: Send> Send for Worker<T>

Auto Trait Implementations

impl<T> !Freeze for Worker<T>

impl<T> !RefUnwindSafe for Worker<T>

impl<T> !Sync for Worker<T>

impl<T> Unpin for Worker<T> where Arc<CachePadded<Inner<T>>>: Unpin, Cell<Buffer<T>>: Unpin,

impl<T> UnsafeUnpin for Worker<T> where Arc<CachePadded<Inner<T>>>: UnsafeUnpin, Cell<Buffer<T>>: UnsafeUnpin,

impl<T> UnwindSafe for Worker<T> where Arc<CachePadded<Inner<T>>>: UnwindSafe, Cell<Buffer<T>>: UnwindSafe,

Blanket Implementations

impl<T> Any for Worker<T> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Worker<T> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Worker<T> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for Worker<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Pointable for Worker<T>

const ALIGN: usize = _;
type Init = T;
unsafe fn init(init: <T as Pointable>::Init) -> usize
unsafe fn deref<'a>(ptr: usize) -> &'a T
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
unsafe fn drop(ptr: usize)

impl<T, U> Into<U> for Worker<T> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Worker<T> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for Worker<T> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>