Struct Handle

pub struct Handle { /* private fields */ }

A handle to a Task that can be used for aborting it.

Implementations

impl Handle

pub fn abort(&self)

Aborts the Task of this Handle.

pub fn abort_on_drop(self) -> Self

Returns a new Handle that will call Handle::abort whenever all of its instances are dropped.

If a Handle is cloned, Handle::abort will only be called once all of the clones are dropped.

This can be really useful if you do not want to worry about calling Handle::abort yourself.

pub fn is_aborted(&self) -> bool

Returns true if the Task of this Handle has been aborted.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Drop for Handle

fn drop(&mut self)

Executes the destructor for this type.