Skip to main content

AppliedPriority

Struct AppliedPriority 

Source
pub struct AppliedPriority { /* private fields */ }
Expand description

What a thread-priority request actually produced.

Returned by set_thread_priority and promote_thread_to_realtime in place of (). The unit return was a lie by omission: on Linux a “successful” set_thread_priority(Highest) can mean you got Highest, or that every privileged path was denied and you silently kept the level you already had (Normal for a fresh thread). This says which - uniformly across platforms, so callers never #[cfg].

Branch on Grant / AppliedPriority::degraded / AppliedPriority::reason / AppliedPriority::mechanism for logic; use the Display impl for the human-readable form.

Implementations§

Source§

impl AppliedPriority

Source

pub fn from_parts( requested: ThreadPriority, effective: ThreadPriority, grant: Grant, reason: Option<FallbackReason>, mechanism: Mechanism, broker_error: Option<BrokerError>, ) -> Option<Self>

Rebuilds an outcome from structured data.

Returns None when the parts contradict each other, such as a broker error without a broker-refused reason.

Source

pub fn requested(&self) -> ThreadPriority

The level the caller requested.

Source

pub fn effective(&self) -> ThreadPriority

The level actually in effect.

Source

pub fn grant(&self) -> Grant

How the request was satisfied.

Source

pub fn reason(&self) -> Option<FallbackReason>

Why the request fell short, if it did.

Source

pub fn mechanism(&self) -> Mechanism

The concrete OS scheduling mechanism the request landed on.

Source

pub fn broker_error(&self) -> Option<BrokerError>

The typed reason a broker refused the grant.

Source

pub fn degraded(&self) -> bool

true when the request did NOT get a clean grant of exactly what was asked - a fall back to a weaker level (Highest -> Normal) or a broker clamp within the level (TimeCritical -> nice -15). Equivalent to reason.is_some(); the FallbackReason says which.

Trait Implementations§

Source§

impl Clone for AppliedPriority

Source§

fn clone(&self) -> AppliedPriority

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AppliedPriority

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for AppliedPriority

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for AppliedPriority

Source§

impl PartialEq for AppliedPriority

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AppliedPriority

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.