Struct Thread 

pub struct Thread { /* private fields */ }

Non-owning handle to an RTOS thread.

Returned by Thread::current and JoinHandle::thread. Dropping a Thread does not destroy the underlying RTOS thread — use JoinHandle for that. Carries the read-only and signal-only operations (get_state, suspend/resume, request_stop, …).

Implementations

impl Thread

pub fn sleep_ms(ms: u32)

Sleep the current thread for ms milliseconds.

pub fn yield_now()

Yield the current thread’s time slice.

pub fn current() -> Self

Get a non-owning handle to the currently running thread.

pub fn builder() -> Builder

Begin spawning a new thread. Returns a fluent Builder.

let h = Thread::builder()
    .name(c"worker")
    .priority(Priority::Normal)
    .stack_size(4096)
    .spawn(|tok| { while !tok.is_stopped() { /* work */ } })?;

pub fn suspend(&self)

Suspend this thread.

pub fn resume(&self)

Resume this thread.

pub fn set_priority(&self, prio: Priority)

Set this thread’s priority.

pub fn get_stack_usage(&self) -> usize

Get current stack usage in bytes.

pub fn get_state(&self) -> ThreadState

Get the thread’s current state.

pub fn get_runtime_stats(&self) -> Result<ThreadStats>

Get runtime statistics (CPU time and utilization) for this thread.

Errors

Returns an error if the RTOS does not support runtime statistics or the thread handle is invalid.

pub fn request_stop(&self)

Request the thread to stop cooperatively.

Sets the per-thread atomic cancellation flag. The worker must poll StopToken::is_stopped (via the token it received at spawn time) for this to have any effect — the substrate does NOT force-terminate. Safe from any context (ISR, other thread, the thread itself). Idempotent; the flag is sticky.

pub fn stop_token(&self) -> StopToken

Get a StopToken referencing this thread’s cancellation flag.

pub fn stop_requested(&self) -> bool

true if Thread::request_stop has been called on this thread.

pub fn raw_handle(&self) -> ove_thread_t

Raw handle accessor for advanced use.

Trait Implementations

impl Clone for Thread

fn clone(&self) -> Thread

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Thread

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

Formats the value using the given formatter.

impl Copy for Thread

impl Send for Thread

impl Sync for Thread