Struct KernelPID

pub struct KernelPID(pub(crate) kernel_pid_t);

Wrapper around a valid (not necessarily running, but in-range) riot_sys::kernel_pid_t that provides access to thread details and signaling.

Tuple Fields

0: kernel_pid_t

Implementations

impl KernelPID

pub fn new(pid: kernel_pid_t) -> Option<Self>

pub fn all_pids() -> impl Iterator<Item = KernelPID>

pub fn get_name(&self) -> Option<&str>

pub fn status(&self) -> Result<Status, NoSuchThread>

Get the current status of the thread of that number, if one currently exists

pub fn wakeup(&self) -> Result<(), NoSuchThread>

fn thread(&self) -> Result<*const thread_t, NoSuchThread>

Pick the thread_t out of sched_threads for the PID

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

pub fn stack_stats(&self) -> Result<StackStats, StackStatsError>

Gather information about the stack’s thread.

A None being returned can have two reasons:

• The thread does not exist, or
• develhelp is not active.

This is not backed by C functions (as most of the rest of this crate is), but rather a practical way to access struct members that may or may not be present in a build.

Trait Implementations

impl Clone for KernelPID

fn clone(&self) -> KernelPID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KernelPID

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

Formats the value using the given formatter.

impl From<KernelPID> for NonZero<u16>

fn from(pid: KernelPID) -> Self

Converts to this type from the input type.

impl Into<i16> for &KernelPID

fn into(self) -> kernel_pid_t

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

impl Into<i16> for KernelPID

fn into(self) -> kernel_pid_t

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

impl PartialEq for KernelPID

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for KernelPID

impl StructuralPartialEq for KernelPID

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 2 bytes