Struct TaskHandle

pub struct TaskHandle { /* private fields */ }

An owned permission to perform actions on a task.

Implementations

impl TaskHandle

pub fn pause(&self)

Pause execution of the task. This can have unintended consequences if you are not careful, for example, if this task is holding a mutex when paused, there is no way to retrieve it until the task is unpaused.

pub fn unpause(&self)

Resumes execution of the task.

pub fn set_priority(&self, priority: impl Into<u32>)

Sets the task’s priority, allowing you to control how much cpu time is allocated to it.

pub fn state(&self) -> TaskState

Get the state of the task.

pub fn notify(&self)

Send a notification to the task.

pub fn join(self)

Waits for the task to finish, and then deletes it.

pub fn abort(self)

Aborts the task and consumes it. Memory allocated by the task will not be freed.

pub fn name(&self) -> Result<String, Utf8Error>

Gets the name of the task if possible.

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 Debug for TaskHandle

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

Formats the value using the given formatter.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TaskHandle

impl Send for TaskHandle