Struct mz_ore::task::JoinHandle

pub struct JoinHandle<T>(JoinHandle<T>);

Available on crate feature async only.

Wraps a tokio JoinHandle and provides 4 exclusive (i.e. they take self ownership) operations:

• abort_on_drop: create an AbortOnDropHandle that will automatically abort the task when the handle is dropped.
• JoinHandleExt::wait_and_assert_finished: wait for the task to finish and return its return value.
• JoinHandleExt::abort_and_wait: abort the task and wait for it to be finished.
• into_tokio_handle: turn it into an ordinary tokio JoinHandle.

Tuple Fields

0: JoinHandle<T>

Implementations

impl<T> JoinHandle<T>

pub fn abort_on_drop(self) -> AbortOnDropHandle<T>

Create an AbortOnDropHandle from this JoinHandle.

pub fn is_finished(&self) -> bool

Checks if the task associated with this JoinHandle has finished.a

pub fn into_tokio_handle(self) -> TokioJoinHandle<T>

Checks if the task associated with this JoinHandle has finished.a

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.

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

fn wait_and_assert_finished<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = T> + Send + 'async_trait>>

where Self: 'async_trait,

Waits for the task to finish, resuming the unwind if the task panicked.

fn abort_and_wait<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait,

Aborts the task, then waits for it to complete.