Skip to main content

TaskId

Struct TaskId 

Source
#[repr(transparent)]
pub struct TaskId(pub u32);
Expand description

A type-safe, zero-cost wrapper for an OSAL Task ID.

Tuple Fields§

§0: u32

Implementations§

Source§

impl TaskId

Source

pub fn set_priority(&self, priority: u8) -> Result<()>

Sets the priority of this task.

§Arguments
  • priority: The new priority (0=highest, 255=lowest).
Source

pub fn current() -> Result<Self>

Retrieves the TaskId of the currently executing task.

Source

pub fn index(&self) -> Result<u32>

Returns a zero-based index for this task, suitable for indexing into a user-provided per-task context array.

This is the workaround for OSAL not supporting per-task arguments (see nasa/osal#1394). Usage:

static CONTEXTS: [AtomicPtr<()>; 16] = /* ... */;

// At task creation:
let task = Task::new("worker", worker_entry, ...)?;
CONTEXTS[task.id().index()? as usize].store(ctx_ptr, Ordering::Release);

// Inside the task:
let idx = TaskId::current()?.index()? as usize;
let ctx = CONTEXTS[idx].load(Ordering::Acquire);
Source

pub fn current_index() -> Result<u32>

Shorthand: get the current task’s zero-based index.

Source

pub fn from_name(name: &str) -> Result<Self>

Finds an existing OSAL task ID by its name.

Trait Implementations§

Source§

impl Clone for TaskId

Source§

fn clone(&self) -> TaskId

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 TaskId

Source§

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

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

impl PartialEq for TaskId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for TaskId

Source§

impl Eq for TaskId

Source§

impl StructuralPartialEq for TaskId

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, 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.