ThreadNotification

Enum ThreadNotification 

Source
pub enum ThreadNotification {
    NoAction,
    SetBits(u32),
    Increment,
    SetValueWithOverwrite(u32),
    SetValueWithoutOverwrite(u32),
}
Expand description

Thread notification actions.

Defines different ways to notify a thread using the FreeRTOS task notification mechanism. Task notifications provide a lightweight alternative to semaphores and queues for simple signaling.

§Examples

use osal_rs::os::{Thread, ThreadNotification};
 
let thread = Thread::current();
 
// Increment notification counter
thread.notify_with_action(ThreadNotification::Increment);
 
// Set specific bits
thread.notify_with_action(ThreadNotification::SetBits(0b1010));
 
// Set value, overwriting any existing value
thread.notify_with_action(ThreadNotification::SetValueWithOverwrite(42));

Variants§

§

NoAction

Don’t update the notification value

§

SetBits(u32)

Bitwise OR the notification value with the specified bits

§

Increment

Increment the notification value by one

§

SetValueWithOverwrite(u32)

Set the notification value, overwriting any existing value

§

SetValueWithoutOverwrite(u32)

Set the notification value only if the receiving thread has no pending notifications

Trait Implementations§

Source§

impl Clone for ThreadNotification

Source§

fn clone(&self) -> ThreadNotification

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ThreadNotification

Source§

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

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

impl Into<(u32, u32)> for ThreadNotification

Source§

fn into(self) -> (u32, u32)

Converts this type into the (usually inferred) input type.
Source§

impl Copy for ThreadNotification

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.