Struct crs_bind::rtos::Task

pub struct Task(_);

Represents a FreeRTOS task.

Implementations

impl Task

pub const DEFAULT_PRIORITY: u32

The default priority for new tasks.

pub const DEFAULT_STACK_DEPTH: u16

The default stack depth for new tasks.

pub fn delay(dur: Duration)

Delays the current task by the specified duration.

pub fn current() -> Task

Gets the current task.

pub fn find_by_name(name: &str) -> Result<Task, Error>

Finds a task by its name.

pub fn spawn<F>(f: F) -> Result<Task, Error> where
    F: FnOnce() + Send + 'static, 

Spawns a new task with no name and the default priority and stack depth.

pub fn spawn_ext<F>(
    name: &str,
    priority: u32,
    stack_depth: u16,
    f: F
) -> Result<Task, Error> where
    F: FnOnce() + Send + 'static, 

Spawns a new task with the specified name, priority and stack depth.

pub fn spawn_raw(
    name: &str,
    priority: u32,
    stack_depth: u16,
    f: unsafe extern "C" fn(arg1: *mut c_void),
    arg: *mut c_void
) -> Result<Task, Error>

Spawns a new task from a C function pointer and an arbitrary data pointer.

pub fn name(&self) -> String

Gets the name of the task.

pub fn priority(&self) -> u32

Gets the priority of the task.

pub fn state(&self) -> TaskState

Gets the state of the task.

pub unsafe fn delete(&self)

Unsafely deletes the task.

Safety

This is unsafe because it does not guarantee that the task’s code safely unwinds (i.e., that destructors are called, memory is freed and other resources are released).

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a copy of the value.

pub 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 Eq for Task

impl Ord for Task

fn cmp(&self, other: &Task) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Task> for Task

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Task> for Task

fn partial_cmp(&self, other: &Task) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for Task

impl StructuralEq for Task

impl StructuralPartialEq for Task

impl Sync for Task