Enum WinAPIThreadPriority

#[repr(u32)]
pub enum WinAPIThreadPriority {
    BackgroundModeBegin = 65_536,
    BackgroundModeEnd = 131_072,
    AboveNormal = 1,
    BelowNormal = 4_294_967_295,
    Highest = 2,
    Idle = 4_294_967_281,
    Lowest = 4_294_967_294,
    Normal = 0,
    TimeCritical = 15,
}

The WinAPI priority representation. Check out MSDN for more info: https://docs.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-setthreadpriority

Variants

BackgroundModeBegin = 65_536

Begin background processing mode. The system lowers the resource scheduling priorities of the thread so that it can perform background work without significantly affecting activity in the foreground.

This value can be specified only if hThread is a handle to the current thread. The function fails if the thread is already in background processing mode.

Warning

Windows Server 2003: This value is not supported.

BackgroundModeEnd = 131_072

End background processing mode. The system restores the resource scheduling priorities of the thread as they were before the thread entered background processing mode.

This value can be specified only if hThread is a handle to the current thread. The function fails if the thread is not in background processing mode.

Warning

Windows Server 2003: This value is not supported.

AboveNormal = 1

Priority 1 point above the priority class.

BelowNormal = 4_294_967_295

Priority 1 point below the priority class.

Highest = 2

Priority 2 points above the priority class.

Idle = 4_294_967_281

Base priority of 1 for IDLE_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, or HIGH_PRIORITY_CLASS processes, and a base priority of 16 for REALTIME_PRIORITY_CLASS processes.

Lowest = 4_294_967_294

Priority 2 points below the priority class.

Normal = 0

Normal priority for the priority class.

TimeCritical = 15

Base priority of 15 for IDLE_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, or HIGH_PRIORITY_CLASS processes, and a base priority of 31 for REALTIME_PRIORITY_CLASS processes.

Trait Implementations

impl Clone for WinAPIThreadPriority

fn clone(&self) -> WinAPIThreadPriority

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WinAPIThreadPriority

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

Formats the value using the given formatter.

impl From<WinAPIThreadPriority> for ThreadPriorityOsValue

fn from(p: WinAPIThreadPriority) -> Self

Converts to this type from the input type.

impl Hash for WinAPIThreadPriority

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 WinAPIThreadPriority

fn cmp(&self, other: &WinAPIThreadPriority) -> 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 WinAPIThreadPriority

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

fn partial_cmp(&self, other: &WinAPIThreadPriority) -> 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 TryFrom<ThreadPriority> for WinAPIThreadPriority

type Error = Error

The type returned in the event of a conversion error.

fn try_from(priority: ThreadPriority) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for WinAPIThreadPriority

type Error = Error

The type returned in the event of a conversion error.

fn try_from(priority: DWORD) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for WinAPIThreadPriority

impl Eq for WinAPIThreadPriority

impl StructuralPartialEq for WinAPIThreadPriority