Struct Handle 

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

Available on crate feature coroutine only.

Join handle for async task

This is a wrapper around tokio’s JoinHandle type.

Implementations

impl<T> Handle<T>

pub fn into_robust(self) -> RobustHandle<T>

Convert this handle into a RobustHandle. with a more robust mechanism for aborting.

pub fn is_finished(&self) -> bool

Test if the task has finished and is ready to be joined

pub fn abort(&self)

Abort the task, trying to join or co_join an aborted task (if it’s not already completed) will return an error indicating it’s already aborted.

If the task was completed before joining, however, it may not see this abort call. If you always want join to indicate aborted, see RobustHandle

pub fn abort_handle(&self) -> AbortHandle

Return a handle to remotely abort the task

pub fn join(self) -> Result<T>

Block the current thread to join the task

Panics are caught by the runtime, and will be returned as an Err.

Will error if the task was aborted or panicked. If you want to handle the abort, use join_maybe_aborted

Blocking

Do not use this in an async context, since it will block the runtime, and will panic if the thread is currently driving IO. Use co_join().await instead.

pub async fn co_join(self) -> Result<T>

Wait for the task asynchronously

Panics are caught by the runtime, and will be returned as an Err.

Will error if the task was aborted or panicked. If you want to handle the abort, use co_join_maybe_aborted

pub fn join_maybe_aborted(self) -> Result<Option<T>>

Like join, but returns None if the task was aborted.

Panics are caught by the runtime, and will be returned as an Err.

Blocking

Do not use this in an async context, since it will block the runtime, and will panic if the thread is currently driving IO. Use co_join_maybe_aborted().await instead.

pub async fn co_join_maybe_aborted(self) -> Result<Option<T>>

Like co_join, but returns None if the task was aborted.

Trait Implementations

impl<T> From<Handle<T>> for RobustHandle<T>

fn from(value: Handle<T>) -> Self

Converts to this type from the input type.