Struct task_pool::Task

pub struct Task<T, B: QueueBacking> { /* private fields */ }

A handle to a queued group of work units, which output a single result.

Implementations

impl<T, B: QueueBacking> Task<T, B>

pub fn cancel(self)

Cancels this task, preventing any further threads from performing its work.

pub fn complete(&self) -> bool

Whether the task has been completed yet.

pub fn result(self) -> Result<T, Self>

Attempts to get the result of this task if it has been completed. Otherwise, returns the original task.

pub fn join(self) -> T

Joins the current thread with this task, completing all remaining work. After all work is complete, yields the result.

pub fn join_work(&self)

Joins with the remaining work on this task, completing all units while they are available. Returns immediately if there are outstanding units in progress on other threads.

impl<T, P: Ord + Send> Task<T, Priority<P>>

pub fn set_priority(&mut self, priority: P)

Updates the priority of this task to the specified value.

Trait Implementations

impl<T: Debug, B: Debug + QueueBacking> Debug for Task<T, B>

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

Formats the value using the given formatter.

impl<T, B: QueueBacking> Future for Task<T, B>

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.