Struct JoinHandle 

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

A handle that awaits the result of a task.

Dropping a JoinHandle will cancel the task. To run the task in the background, use JoinHandle::detach.

Implementations

impl<T> JoinHandle<T>

pub async fn cancel(self) -> Option<T>

Cancel the task and wait for the result, if any.

pub fn detach(self)

Detach the task to let it run in the background.

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> Drop for JoinHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

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.

impl<T: Send> Send for JoinHandle<T>

If T is send, we can poll result from other thread

impl<T> Sync for JoinHandle<T>

JoinHandle does not expose any &self interface, so it’s unconditionally Sync.

impl<T> Unpin for JoinHandle<T>