Struct os_id::ThreadName

pub struct ThreadName { /* private fields */ }

Thread name, limited to 16 characters which is common limit for unix systems.

Note that actual limit is 15 characters as 16 includes is needed for terminating character.

Commonly it is valid utf-8 string, but due to potential encoding differences, it is possible that name cannot be interpreted as utf-8 string. In this case user is encouraged to use as_bytes method and perform conversion by himself.

fmt

• Debug trait outputs content as 16 bytes.

• Display trait outputs content as string, if possible, otherwise fallbacks to byte slice.

Implementations

impl ThreadName

pub const fn new() -> Self

Creates new empty string name

pub const fn name(name: [u8; 16]) -> Self

Initializes name from buffer.

pub fn current() -> Self

Retrieves current thread’s name

pub fn as_bytes(&self) -> &[u8]

Returns name as byte slice

pub fn as_str(&self) -> Result<&str, &[u8]>

Returns name as string, checking whether it is valid utf-8 before.

In case of underlying name not to be valid string, returns byte slice with content.

On windows it never fails.

Trait Implementations

impl AsRef<[u8]> for ThreadName

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Borrow<[u8]> for ThreadName

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for ThreadName

fn clone(&self) -> ThreadName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadName

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

Formats the value using the given formatter.

impl Display for ThreadName

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

Formats the value using the given formatter.

impl Hash for ThreadName

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ThreadName

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<&'_ [u8]> for ThreadName

fn eq(&self, other: &&[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<&'_ str> for ThreadName

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<[u8]> for ThreadName

fn eq(&self, other: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ThreadName> for ThreadName

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ThreadName> for &str

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ThreadName> for str

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ThreadName> for &[u8]

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<ThreadName> for [u8]

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<str> for ThreadName

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ThreadName> for ThreadName

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ThreadName

impl Eq for ThreadName