Struct ThreadId 

pub struct ThreadId {
    pub process: ProcessId,
    raw: NonZeroU64,
}

A globally-unique id identifying a thread within a specific process.

The primary purpose of this id is to allow the consumer of telemetry messages to associate spans with the callstack they came from to reconstruct parent-child relationships. On a normal operating system this is the thread, on other systems it should be whatever is the closest equivalent, e.g. for FreeRTOS it would be a task. On a single threaded bare-metal system it would be a constant as there is only the one callstack.

Fields

process: ProcessId

The globally-unique id for the process this thread is within.

raw: NonZeroU64

The process-unique id for this thread within the process.

Implementations

impl ThreadId

pub const fn from_raw(process: ProcessId, raw: NonZeroU64) -> Self

Creates a ThreadId from a raw value.

Extra care needs to be taken that this is not a constant value or re-used within this process in any way.

pub(crate) fn current(process: ProcessId) -> Self

Creates a ThreadId for the current thread, using OS specific means to acquire it.

pub fn raw(&self) -> NonZeroU64

Returns the raw value of this id.

Trait Implementations

impl Clone for ThreadId

fn clone(&self) -> ThreadId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThreadId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ThreadId

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

Formats the value using the given formatter.

impl FromStr for ThreadId

type Err = ParseThreadIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ThreadId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ThreadId

fn cmp(&self, other: &ThreadId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ThreadId

fn eq(&self, other: &ThreadId) -> 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 PartialOrd for ThreadId

fn partial_cmp(&self, other: &ThreadId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ThreadId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ThreadId

impl Eq for ThreadId

impl StructuralPartialEq for ThreadId