Struct JoinHandle 

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

A native local task handle. It is neither Send nor Sync.

Returned by crate::rt::spawn() and crate::rt::Runtime::spawn(). Dropping the handle detaches the task. Awaiting it yields the task’s output, or an error if no output is available, for example after cancellation, a task panic, or runtime shutdown.

Implementations

impl<T> JoinHandle<T>

pub fn cancel(self)

Requests cancellation and discards the result without waiting for cleanup.

The future is dropped when the runtime next processes the task, or during runtime shutdown. A running poll is not interrupted.

pub fn detach(self)

Detaches the task so it continues running independently.

pub fn is_finished(&self) -> bool

Returns true if the task completed or was closed without an output.

Trait Implementations

impl<T: Debug> Debug for JoinHandle<T>

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

Formats the value using the given formatter.

impl<T> Future for JoinHandle<T>

type Output = Result<T, JoinError>

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.