Task

Struct Task 

Source
pub struct Task<T: 'static + Send>(/* private fields */);
Expand description

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

Implementations§

Source§

impl<T: 'static + Send> Task<T>

Source

pub fn cancel(self)

Cancels this task, preventing it from running if it was not yet started.

Source

pub fn complete(&self) -> bool

Whether the task has been completed yet.

Source

pub fn help(&self)

Steals any outstanding work on this task. Returns immediately if there are remaining units in progress on other threads.

Source

pub fn join(self) -> T

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

Source

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.

Auto Trait Implementations§

§

impl<T> Freeze for Task<T>

§

impl<T> !RefUnwindSafe for Task<T>

§

impl<T> Send for Task<T>

§

impl<T> Sync for Task<T>

§

impl<T> Unpin for Task<T>

§

impl<T> !UnwindSafe for Task<T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.