Struct ThreadHandle 

pub struct ThreadHandle { /* private fields */ }

A strong reference used to inspect and control a live thread.

Implementations

impl ThreadHandle

pub fn set_policy(&self, policy: SchedulePolicy) -> Result<(), TaskError>

Updates a thread scheduling policy through its owner CPU.

Errors

Returns TaskError::UnsafeContext in hard IRQ context and propagates policy validation, Deadline admission, identity, and CPU publication failures.

pub fn affinity(&self) -> Result<CpuSet, TaskError>

Returns a copy of a thread’s CPU affinity.

pub fn request_affinity( &self, affinity: CpuSet, ) -> Result<ThreadAffinityChange, TaskError>

Requests an affinity change and returns its owner-runqueue completion.

Dropping the completion leaves the request asynchronous. Use wait() or Self::set_affinity_and_wait when placement must finish before return.

pub fn set_affinity_and_wait(&self, affinity: CpuSet) -> Result<(), TaskError>

Updates a remote thread’s affinity and waits for owner-runqueue completion.

A successful return guarantees that this update was ordered through the target’s owner runqueue. If no later setter superseded it, the target no longer executes on, is queued on, or has an in-flight transfer to a CPU excluded by this affinity. Setters that join the same outstanding owner transition share the target’s monotonically increasing completion sequence.

pub fn lookup(thread: ThreadId) -> Result<Self, TaskError>

Looks up a generation-valid thread through the runtime-owned task system.

pub fn runtime(&self) -> Result<ThreadRuntimeSnapshot, TaskError>

Returns a cumulative charged-runtime snapshot for a live thread.

impl ThreadHandle

pub fn id(&self) -> ThreadId

Returns the generation-checked registry identity.

pub fn base_policy(&self) -> SchedulePolicy

Returns the thread’s base scheduling policy.

pub fn effective_policy(&self) -> SchedulePolicy

Returns the policy after priority-inheritance donation is applied.

pub fn execution_reclaimed(&self) -> bool

Reports physical execution-resource reclamation independently of logical exit.

pub fn state(&self) -> ThreadState

Returns the most recently published lifecycle state.

pub fn downgrade(&self) -> WeakThreadHandle

Creates a non-owning lifecycle observer.

pub fn wake_handle(&self) -> ThreadWakeHandle

Creates a direct wake handle that does not consult the thread registry.

pub fn scheduler_fence_cpu(&self) -> Option<CpuId>

Returns the physical CPU that must cross a scheduler boundary.

Unlike direct wake placement, this snapshot remains on the source CPU until switch tail releases the outgoing context. A task-context caller can therefore publish state, take this snapshot, and rendezvous with the returned CPU; either the thread is still active there or it crossed a scheduler boundary after the publication.

pub fn assigned_cpu(&self) -> Option<CpuId>

Returns Linux task_cpu(): the last committed runqueue assignment.

This remains the previous CPU while a task sleeps and changes to the destination when an rq-to-rq migration commits. Physical execution ownership is exposed separately by Self::scheduler_fence_cpu. A wake-placement hint is never reported as scheduler placement.

impl ThreadHandle

pub fn extension(&self) -> Option<ThreadExtensionBorrow<'_>>

Borrows the directly attached OS extension for the lifetime of this handle.

pub fn wait(&self) -> Result<i32, TaskError>

Waits for logical exit while retaining the task identity and OS extension.

pub fn join(self) -> Result<i32, TaskError>

Waits for exit and transfers final reclamation to the task-context reaper.

pub fn detach(self)

Relinquishes the caller’s management lease; the scheduler owns execution.

Trait Implementations

impl Clone for ThreadHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadHandle

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

Formats the value using the given formatter.

impl Drop for ThreadHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for ThreadHandle

impl PartialEq for ThreadHandle

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

Equality operator ==.

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

Inequality operator !=.