Struct tokio_util::task::AbortOnDropHandle

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

Available on crate feature rt only.

A wrapper around a tokio::task::JoinHandle, which aborts the task when it is dropped.

Implementations

impl<T> AbortOnDropHandle<T>

pub fn new(handle: JoinHandle<T>) -> Self

Create an AbortOnDropHandle from a JoinHandle.

pub fn abort(&self)

Abort the task associated with this handle, equivalent to JoinHandle::abort.

pub fn is_finished(&self) -> bool

Checks if the task associated with this handle is finished, equivalent to JoinHandle::is_finished.

pub fn abort_handle(&self) -> AbortHandle

Returns a new AbortHandle that can be used to remotely abort this task, equivalent to JoinHandle::abort_handle.

Trait Implementations

impl<T> AsRef<JoinHandle<T>> for AbortOnDropHandle<T>

fn as_ref(&self) -> &JoinHandle<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Debug> Debug for AbortOnDropHandle<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Drop for AbortOnDropHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Future for AbortOnDropHandle<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.