Struct TaskHandle

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

A handle which references a task.

This handle behaves much like a regular future: it is marked as #[must_use], it won’t start doing work until .awaited, and when dropped will cancel the underlying task. See spawn or spawn_relaxed for more details.

Trait Implementations

impl<T: Debug + Send> Debug for TaskHandle<T>

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

Formats the value using the given formatter.

impl<T: Send> Drop for TaskHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Future for TaskHandle<T>

The future for the task handle. Either produces a value, or an error if the task has panicked during execution.

type Output = Result<T, Box<dyn Any + Send>>

The type of value produced on completion.

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

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

impl<'pin, T: Send> Unpin for TaskHandle<T>

where PinnedFieldsOf<__TaskHandle<'pin, T>>: Unpin,