Struct TaskHandle

pub struct TaskHandle<T> { /* private fields */ }

An opaque handle to some task which is running in the background.

Implementations

impl<T> TaskHandle<T>

pub fn spawn<K>(task: K) -> TaskHandle<T>

where K: Task<Output = T> + UnwindSafe + Send + Sync + 'static, T: Send + Sync + 'static,

Spawn a Task in the background, returning the a TaskHandle so you can cancel it or retrieve the result later on.

pub fn poll(&self) -> Option<Result<T, Error>>

Check if the background task has finished.

If the other end hangs up for whatever reason this will return an error.

pub fn wait(self) -> Result<T, Error>

Block the current thread until the task has finished and returned a result.

pub fn cancel(&self)

Cancel the background task.

pub fn cancelled(&self) -> bool

Has this task been cancelled?

Trait Implementations

impl<T> Drop for TaskHandle<T>

fn drop(&mut self)

Executes the destructor for this type.