Struct Stealer

pub struct Stealer<'worker, S> { /* private fields */ }

A handle for stealing tasks from a Scheduler’s run queue, or an Injector queue.

While this handle exists, no other worker can steal tasks from the queue.

Implementations

impl<'worker, S: Schedule> Stealer<'worker, S>

pub fn initial_task_count(&self) -> usize

Returns the number of tasks that were in the targeted queue when this Stealer was created.

This number is not guaranteed to be greater than the current number of tasks returned by task_count, as new tasks may be enqueued while stealing.

pub fn task_count(&self) -> usize

Returns the number of tasks currently in the targeted queue.

pub fn spawn_one(&self, scheduler: &S) -> bool

Steal one task from the targeted queue and spawn it on the provided scheduler.

Returns

• true if a task was successfully stolen.
• false if the targeted queue is empty.

pub fn spawn_n(&self, scheduler: &S, max: usize) -> usize

Steal up to max tasks from the targeted queue and spawn them on the provided scheduler.

Returns

The number of tasks stolen. This may be less than max if the targeted queue contained fewer tasks than max.

pub fn spawn_half(&self, scheduler: &S) -> usize

Steal half of the tasks currently in the targeted queue and spawn them on the provided scheduler.

This is a convenience method that is equivalent to the following:

stealer.spawn_n(&scheduler, stealer.initial_task_count() / 2);

Returns

The number of tasks stolen.

Trait Implementations

impl<S> Debug for Stealer<'_, S>

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

Formats the value using the given formatter.