Struct JoinHandle

pub struct JoinHandle<T>(/* private fields */);

The return value of the spawn_local() function

Can be used to abort the future, or to get the value from a different thread with .await

This trait implements future. Polling it after it finished or aborted may result in a panic.

Implementations

impl<T> JoinHandle<T>

pub fn abort(self)

If the future hasn’t completed yet, this will make the event loop stop polling the corresponding future and it will be dropped

Once this handle has been aborted, it can no longer be polled

pub fn is_finished(&self) -> bool

Checks if the task associated with this JoinHandle has finished.

Trait Implementations

impl<T> Future for JoinHandle<T>

type Output = T

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<T: Send> Send for JoinHandle<T>