Struct Task 

pub struct Task { /* private fields */ }

Handle for a FreeRTOS task

Implementations

impl Task

pub fn new() -> TaskBuilder

Prepare a builder object for the new task.

pub unsafe fn from_raw_handle(handle: TaskHandle_t) -> Self

Safety

handle must be a valid FreeRTOS task handle.

pub fn raw_handle(&self) -> TaskHandle_t

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

Get the name of the current task.

pub fn current() -> Result<Task, FreeRtosError>

Try to find the task of the current execution context.

pub fn set_notification_value(&self, val: u32)

Forcibly set the notification value for this task.

pub fn notify(&self, notification: TaskNotification)

Notify this task.

pub fn notify_from_isr( &self, context: &mut InterruptContext, notification: TaskNotification, ) -> Result<(), FreeRtosError>

Notify this task from an interrupt.

pub fn wait_for_notification( &self, clear_bits_enter: u32, clear_bits_exit: u32, wait_for: Duration, ) -> Result<u32, FreeRtosError>

Wait for a notification to be posted.

pub fn get_stack_high_water_mark(&self) -> UBaseType_t

Get the minimum amount of stack that was ever left on this task.

pub unsafe fn get_id(&self) -> UBaseType_t

Safety

This function is not thread safe, you must synchronize all usage of it, Task::set_id, and vTaskSetTaskNumber called with the same task handle manually.

pub unsafe fn set_id(&self, value: UBaseType_t)

Safety

This function is not thread safe, you must synchronize all usage of it, Task::get_id, uxTaskGetTaskNumber and vTaskSetTaskNumber called with the same task handle manually.

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl Send for Task

impl Sync for Task