Struct ThreadMetadata 

pub struct ThreadMetadata {
    pub thread: ThreadHandle,
    pub name: Bytes<MAX_TASK_NAME_LEN>,
    pub stack_depth: StackType,
    pub priority: UBaseType,
    pub thread_number: UBaseType,
    pub state: ThreadState,
    pub current_priority: UBaseType,
    pub base_priority: UBaseType,
    pub run_time_counter: UBaseType,
    pub stack_high_water_mark: StackType,
}

All OSAL trait definitions for advanced usage. Metadata and runtime information about a thread.

Contains detailed information about a thread’s state, priorities, stack usage, and runtime statistics.

Examples

use osal_rs::os::*;

let thread = Thread::get_current();
let metadata = thread.get_metadata();

// Name, priority and stack usage are all part of the snapshot.
let _ = (metadata.name.as_str(), metadata.priority, metadata.stack_high_water_mark);

assert_ne!(metadata.state, ThreadState::Invalid);

Fields

thread: ThreadHandle

OS-level thread/task handle

name: Bytes<MAX_TASK_NAME_LEN>

Thread name

stack_depth: StackType

Original stack depth allocated for this thread

priority: UBaseType

Thread priority

thread_number: UBaseType

Unique thread number assigned by OS

state: ThreadState

Current execution state

current_priority: UBaseType

Current priority (may differ from base priority due to priority inheritance)

base_priority: UBaseType

Base priority without inheritance

run_time_counter: UBaseType

Total runtime counter (requires configGENERATE_RUN_TIME_STATS)

stack_high_water_mark: StackType

Minimum remaining stack space ever recorded (lower values indicate higher stack usage)

Trait Implementations

impl Clone for ThreadMetadata

fn clone(&self) -> ThreadMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadMetadata

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

Formats the value using the given formatter.

impl Default for ThreadMetadata

Provides default values for ThreadMetadata.

Creates a metadata instance with null/zero values, representing an invalid or uninitialized thread.

fn default() -> Self

Returns the “default value” for a type.

impl Send for ThreadMetadata

impl Sync for ThreadMetadata