Struct TaskHandle 

pub struct TaskHandle { /* private fields */ }

A non-owning task handle whose drop does not cancel the task. Use TaskHandle::owned for cancellation on drop.

Implementations

impl TaskHandle

pub fn cancel(&self)

Cancel the task. Component and window tasks require Freya’s current context.

pub fn try_cancel(&self)

Try to cancel the task if Freya’s current context is available.

Unlike TaskHandle::cancel, this does nothing when called outside Freya’s context. Prefer it in destructors and other cleanup paths where a context might no longer exist.

pub fn is_finished(&self) -> bool

Check whether the task is no longer scheduled.

pub fn owned(self) -> OwnedTaskHandle

Upgrade to an OwnedTaskHandle that cancels the task when its last clone is dropped. Retain the returned handle for as long as the task should run. Useful for a task owned by another long-lived value rather than by a component scope.

Trait Implementations

impl Clone for TaskHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskHandle

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

Formats the value using the given formatter.

impl Eq for TaskHandle

impl Hash for TaskHandle

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TaskHandle

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.