Enum thread_priority::windows::WinAPIThreadPriority

#[repr(u32)]pub enum WinAPIThreadPriority {
    BackgroundModeBegin,
    BackgroundModeEnd,
    AboveNormal,
    BelowNormal,
    Highest,
    Idle,
    Lowest,
    Normal,
    TimeCritical,
}

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

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

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

Priority 1 point above the priority class.

BelowNormal

Priority 1 point below the priority class.

Highest

Priority 2 points above the priority class.

Idle

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

Priority 2 points below the priority class.

Normal

Normal priority for the priority class.

TimeCritical

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 Copy for WinAPIThreadPriority

impl Debug for WinAPIThreadPriority

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

Formats the value using the given formatter.

impl Eq for WinAPIThreadPriority

impl Ord for WinAPIThreadPriority

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<WinAPIThreadPriority> for WinAPIThreadPriority

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<WinAPIThreadPriority> for WinAPIThreadPriority

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 StructuralEq for WinAPIThreadPriority

impl StructuralPartialEq for WinAPIThreadPriority

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.