Struct thread_priority::ThreadPriorityValue

pub struct ThreadPriorityValue(_);

Platform-independent thread priority value. Should be in [0; 100) range. The higher the number is - the higher the priority.

The only way to create such a value is a safe conversion from an 8-byte unsigned integer (u8):

use thread_priority::*;
use std::convert::{TryFrom, TryInto};

// Create the lowest possible priority value.
assert!(ThreadPriorityValue::try_from(0u8).is_ok());
// Create it implicitly via `TryInto`:
let _priority = ThreadPriority::Crossplatform(0u8.try_into().unwrap());

In case you need to get the raw value out of it, use the Into<u8> trait:

use thread_priority::*;
use std::convert::TryFrom;

// Create the lowest possible priority value.
let priority = ThreadPriorityValue::try_from(0u8).unwrap();
// Create it implicitly via `TryInto`:
let raw_value: u8 = priority.into();
assert_eq!(raw_value, 0);

Implementations

impl ThreadPriorityValue

pub const MAX: u8 = 99u8

The maximum value for a thread priority.

pub const MIN: u8 = 0u8

The minimum value for a thread priority.

Trait Implementations

impl Clone for ThreadPriorityValue

fn clone(&self) -> ThreadPriorityValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadPriorityValue

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

Formats the value using the given formatter.

impl Default for ThreadPriorityValue

fn default() -> ThreadPriorityValue

Returns the “default value” for a type.

impl Hash for ThreadPriorityValue

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 Into<u8> for ThreadPriorityValue

fn into(self) -> u8

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

impl Ord for ThreadPriorityValue

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

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ThreadPriorityValue> for ThreadPriorityValue

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

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

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

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

impl PartialOrd<ThreadPriorityValue> for ThreadPriorityValue

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

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

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

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

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

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

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

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

const 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 TryFrom<u8> for ThreadPriorityValue

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ThreadPriorityValue

impl Eq for ThreadPriorityValue

impl StructuralEq for ThreadPriorityValue

impl StructuralPartialEq for ThreadPriorityValue