Struct Stealer

struct Stealer<T> { ... }

A stealer handle of a worker queue.

Stealers can be shared among threads.

Task schedulers typically have a single worker queue per worker thread.

Examples

use crossbeam_deque::{Steal, Worker};

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

let s = w.stealer();
assert_eq!(s.steal(), Steal::Success(1));
assert_eq!(s.steal(), Steal::Success(2));
assert_eq!(s.steal(), Steal::Empty);

Implementations

impl<T> Stealer<T>

fn is_empty(self: &Self) -> bool

Returns true if the queue is empty.

use crossbeam_deque::Worker;

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

assert!(s.is_empty());
w.push(1);
assert!(!s.is_empty());
fn len(self: &Self) -> usize

Returns the number of tasks in the deque.

use crossbeam_deque::Worker;

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

assert_eq!(s.len(), 0);
w.push(1);
assert_eq!(s.len(), 1);
w.push(2);
assert_eq!(s.len(), 2);
fn steal(self: &Self) -> Steal<T>

Steals a task from the queue.

Examples

use crossbeam_deque::{Steal, Worker};

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

let s = w.stealer();
assert_eq!(s.steal(), Steal::Success(1));
assert_eq!(s.steal(), Steal::Success(2));
fn steal_batch(self: &Self, dest: &Worker<T>) -> Steal<()>

Steals a batch of tasks and pushes them into another worker.

How many tasks exactly will be stolen is not specified. That said, this method will try to steal around half of the tasks in the queue, but also not more than some constant limit.

Examples

use crossbeam_deque::Worker;

let w1 = Worker::new_fifo();
w1.push(1);
w1.push(2);
w1.push(3);
w1.push(4);

let s = w1.stealer();
let w2 = Worker::new_fifo();

let _ = s.steal_batch(&w2);
assert_eq!(w2.pop(), Some(1));
assert_eq!(w2.pop(), Some(2));
fn steal_batch_with_limit(self: &Self, dest: &Worker<T>, limit: usize) -> Steal<()>

Steals no more than limit of tasks and pushes them into another worker.

How many tasks exactly will be stolen is not specified. That said, this method will try to steal around half of the tasks in the queue, but also not more than the given limit.

Examples

use crossbeam_deque::Worker;

let w1 = Worker::new_fifo();
w1.push(1);
w1.push(2);
w1.push(3);
w1.push(4);
w1.push(5);
w1.push(6);

let s = w1.stealer();
let w2 = Worker::new_fifo();

let _ = s.steal_batch_with_limit(&w2, 2);
assert_eq!(w2.pop(), Some(1));
assert_eq!(w2.pop(), Some(2));
assert_eq!(w2.pop(), None);

w1.push(7);
w1.push(8);
// Setting a large limit does not guarantee that all elements will be popped. In this case,
// half of the elements are currently popped, but the number of popped elements is considered
// an implementation detail that may be changed in the future.
let _ = s.steal_batch_with_limit(&w2, std::usize::MAX);
assert_eq!(w2.len(), 3);
fn steal_batch_and_pop(self: &Self, dest: &Worker<T>) -> Steal<T>

Steals a batch of tasks, pushes them into another worker, and pops a task from that worker.

How many tasks exactly will be stolen is not specified. That said, this method will try to steal around half of the tasks in the queue, but also not more than some constant limit.

Examples

use crossbeam_deque::{Steal, Worker};

let w1 = Worker::new_fifo();
w1.push(1);
w1.push(2);
w1.push(3);
w1.push(4);

let s = w1.stealer();
let w2 = Worker::new_fifo();

assert_eq!(s.steal_batch_and_pop(&w2), Steal::Success(1));
assert_eq!(w2.pop(), Some(2));
fn steal_batch_with_limit_and_pop(self: &Self, dest: &Worker<T>, limit: usize) -> Steal<T>

Steals no more than limit of tasks, pushes them into another worker, and pops a task from that worker.

How many tasks exactly will be stolen is not specified. That said, this method will try to steal around half of the tasks in the queue, but also not more than the given limit.

Examples

use crossbeam_deque::{Steal, Worker};

let w1 = Worker::new_fifo();
w1.push(1);
w1.push(2);
w1.push(3);
w1.push(4);
w1.push(5);
w1.push(6);

let s = w1.stealer();
let w2 = Worker::new_fifo();

assert_eq!(s.steal_batch_with_limit_and_pop(&w2, 2), Steal::Success(1));
assert_eq!(w2.pop(), Some(2));
assert_eq!(w2.pop(), None);

w1.push(7);
w1.push(8);
// Setting a large limit does not guarantee that all elements will be popped. In this case,
// half of the elements are currently popped, but the number of popped elements is considered
// an implementation detail that may be changed in the future.
assert_eq!(s.steal_batch_with_limit_and_pop(&w2, std::usize::MAX), Steal::Success(3));
assert_eq!(w2.pop(), Some(4));
assert_eq!(w2.pop(), Some(5));
assert_eq!(w2.pop(), None);

impl<T> Any for Stealer<T>

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for Stealer<T>

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for Stealer<T>

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

impl<T> Clone for Stealer<T>

fn clone(self: &Self) -> Stealer<T>

impl<T> CloneToUninit for Stealer<T>

unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)

impl<T> Debug for Stealer<T>

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

impl<T> Freeze for Stealer<T>

impl<T> From for Stealer<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Pointable for Stealer<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> RefUnwindSafe for Stealer<T>

impl<T> ToOwned for Stealer<T>

fn to_owned(self: &Self) -> T
fn clone_into(self: &Self, target: &mut T)

impl<T> Unpin for Stealer<T>

impl<T> UnwindSafe for Stealer<T>

impl<T, U> Into for Stealer<T>

fn into(self: 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 for Stealer<T>

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for Stealer<T>

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

impl<T: Send> Send for Stealer<T>

impl<T: Send> Sync for Stealer<T>