Struct freertos_rs::Task

pub struct Task { /* fields omitted */ }

Handle for a FreeRTOS task

Methods

impl Task

pub fn new() -> TaskBuilder

Prepare a builder object for the new task.

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: &InterruptContext,
    notification: TaskNotification
) -> Result<(), FreeRtosError>

Notify this task from an interrupt.

pub fn take_notification<D: DurationTicks>(
    &self,
    clear: bool,
    wait_for: D
) -> u32

Take the notification and either clear the notification value or decrement it by one.

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

Wait for a notification to be posted.

pub fn get_stack_high_water_mark(&self) -> u32

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

Trait Implementations

impl Debug for Task

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

Formats the value using the given formatter.

impl Send for Task