Struct task_pool::TaskQueue

pub struct TaskQueue<B: QueueBacking> { /* private fields */ }

Sends ordered tasks to a pool for background processing.

Implementations

impl<B: PushPopQueueBacking> TaskQueue<B>

pub fn join<T>(&self, task: impl TaskCollection<T>) -> T

Joins the pool in executing the given task. Both the current thread and the background threads complete the task’s work. Semantically, this is equivalent to calling spawn(task).join(), but is more efficient by ensuring that the present thread always receives at least one work item.

pub fn spawn<T>(&self, task: impl TaskCollection<T>) -> Task<T, B>

Spawns a new task into the queue.

impl<P: Ord + Send + Sync> TaskQueue<Priority<P>>

pub fn join<T>(&self, priority: P, task: impl TaskCollection<T>) -> T

Joins the pool in executing the given task. Both the current thread and the background threads complete the task’s work. Semantically, this is equivalent to calling spawn(task).join(), but is more efficient by ensuring that the present thread always receives at least one work item.

pub fn spawn<T>( &self, priority: P, task: impl TaskCollection<T> ) -> Task<T, Priority<P>>

Spawns a new task into the queue, with the given priority.

Trait Implementations

impl<B: QueueBacking> Clone for TaskQueue<B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + QueueBacking> Debug for TaskQueue<B>

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

Formats the value using the given formatter.

impl<B: QueueBacking> Default for TaskQueue<B>

fn default() -> Self

Returns the “default value” for a type.

impl<B: QueueBacking> WorkProvider for TaskQueue<B>

fn change_notifier(&self) -> &ChangeNotifier

Gets a reference to the notifier which raises an event when new work is available.

fn next_task(&self) -> Option<Box<dyn WorkUnit>>

Obtains the next unit of queued work from the provider.