Struct JoinHandle 

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

Handle to a spawned task. Await to get the result.

Dropping the handle detaches the task — it continues running but the output is dropped when the task completes. Use abort() to cancel the task.

JoinHandle is !Send and !Sync — it must stay on the executor thread.

Implementations

impl<T> JoinHandle<T>

pub fn is_finished(&self) -> bool

Returns true if the task has completed (output is ready).

pub fn abort(self) -> bool

Abort the task and consume the handle.

The future is dropped on the next poll cycle. Consumes the handle so it cannot be awaited after abort — this is enforced at the type level rather than via a runtime panic.

Returns true if the task was still running, false if it had already completed (output is dropped by JoinHandle::drop).

Trait Implementations

impl<T> Drop for JoinHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: 'static> Future for JoinHandle<T>

type Output = T

The type of value produced on completion.

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

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