Struct TaskHandle 

pub struct TaskHandle(/* private fields */);

A non-owning handle used to cancel a spawned task manually.

Dropping this handle does not cancel the task. Call TaskHandle::cancel explicitly, or use TaskHandle::owned when the task should be cancelled as its owner is dropped.

Implementations

impl TaskHandle

pub fn cancel(&self)

Cancel the task.

Use it when an event or state change makes an in-progress task no longer necessary. This method must run within Freya’s current context, use TaskHandle::try_cancel for cleanup that may run outside it.

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 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:

struct Worker {
    _task: OwnedTaskHandle,
}

let worker = Worker {
    _task: spawn_forever(forward_messages()).owned(),
};

Trait Implementations

impl Clone for TaskHandle

fn clone(&self) -> TaskHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TaskHandle

impl Debug for TaskHandle

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

Formats the value using the given formatter.

impl Eq for TaskHandle

impl From<TaskId> for TaskHandle

fn from(value: TaskId) -> TaskHandle

Converts to this type from the input type.

impl Hash for TaskHandle

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

where __H: Hasher,

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: &TaskHandle) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TaskHandle