Task

Struct Task 

Source
pub struct Task { /* private fields */ }
Expand description

Handle for a FreeRTOS task

Implementations§

Source§

impl Task

Source

pub fn new() -> TaskBuilder

Prepare a builder object for the new task.

Source

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

§Safety

handle must be a valid FreeRTOS task handle.

Source

pub fn raw_handle(&self) -> FreeRtosTaskHandle

Source

pub fn suspend_all()

Source

pub unsafe fn resume_all()

§Safety

For every call to this method there must be a matching previous call to Task::suspend_all.

Source

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

Get the name of the current task.

Source

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

Try to find the task of the current execution context.

Source

pub fn set_notification_value(&self, val: u32)

Forcibly set the notification value for this task.

Source

pub fn notify(&self, notification: TaskNotification)

Notify this task.

Source

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

Notify this task from an interrupt.

Source

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.

Source

pub fn get_stack_high_water_mark(&self) -> u32

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

Source

pub fn get_id(&self) -> Result<FreeRtosBaseType, FreeRtosError>

Source

pub fn set_id(&mut self, value: FreeRtosUBaseType)

Trait Implementations§

Source§

impl Clone for Task

Source§

fn clone(&self) -> Task

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Task

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Send for Task

Auto Trait Implementations§

§

impl Freeze for Task

§

impl RefUnwindSafe for Task

§

impl !Sync for Task

§

impl Unpin for Task

§

impl UnwindSafe for Task

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.