Enum thread_priority::ThreadPriority
source · [−]pub enum ThreadPriority {
Min,
Crossplatform(ThreadPriorityValue),
Os(ThreadPriorityOsValue),
Deadline {
runtime: Duration,
deadline: Duration,
period: Duration,
},
Max,
}
Expand description
Thread priority enumeration.
Variants
Min
Holds a value representing the minimum possible priority.
Crossplatform(ThreadPriorityValue)
Holds a platform-independent priority value. Usually used when setting a value, for sometimes it is not possible to map the operating system’s priority to this value.
Os(ThreadPriorityOsValue)
Holds an operating system specific value. If it is not possible to obtain the
ThreadPriority::Crossplatform
variant of the value, this is returned instead.
Deadline
Fields
runtime: Duration
Set this to something larger than the average computation time or to the worst-case computation time for hard real-time tasks.
deadline: Duration
Set this to the relative deadline.
period: Duration
Set this to the period of the task.
Holds scheduling parameters for Deadline scheduling. These are, in order, the nanoseconds for runtime, deadline, and period. Please note that the kernel enforces runtime <= deadline <= period.
arrival/wakeup absolute deadline | start time | | | | v v v —–x––––xooooooooooooooooo––––x––––x— |<– Runtime —––>| |<———– Deadline ———–>| |<––––––– Period —————––>|
Max
Holds a value representing the maximum possible priority. Should be used with caution, it solely depends on the target os where the program is going to be running on, how it will behave. On some systems, the whole system may become frozen if not used properly.
Implementations
sourceimpl ThreadPriority
impl ThreadPriority
sourcepub fn max_value_for_policy(
policy: ThreadSchedulePolicy
) -> Result<c_int, Error>
pub fn max_value_for_policy(
policy: ThreadSchedulePolicy
) -> Result<c_int, Error>
Returns the maximum allowed value for using with the provided policy. The returned number is in the range of allowed values.
sourcepub fn min_value_for_policy(
policy: ThreadSchedulePolicy
) -> Result<c_int, Error>
pub fn min_value_for_policy(
policy: ThreadSchedulePolicy
) -> Result<c_int, Error>
Returns the minimum allowed value for using with the provided policy. The returned number is in the range of allowed values.
sourcepub fn to_allowed_value_for_policy(
priority: c_int,
policy: ThreadSchedulePolicy
) -> Result<c_int, Error>
pub fn to_allowed_value_for_policy(
priority: c_int,
policy: ThreadSchedulePolicy
) -> Result<c_int, Error>
Checks that the passed priority value is within the range of allowed values for using with the provided policy.
sourcepub fn to_posix(self, policy: ThreadSchedulePolicy) -> Result<c_int, Error>
pub fn to_posix(self, policy: ThreadSchedulePolicy) -> Result<c_int, Error>
Converts the priority stored to a posix number. POSIX value can not be known without knowing the scheduling policy https://linux.die.net/man/2/sched_get_priority_max
sourcepub fn from_posix(params: ScheduleParams) -> ThreadPriority
pub fn from_posix(params: ScheduleParams) -> ThreadPriority
Gets priority value from POSIX value. In order to interpret it correctly, you should also take scheduling policy into account.
sourceimpl ThreadPriority
impl ThreadPriority
sourcepub fn set_for_current(self) -> Result<(), Error>
pub fn set_for_current(self) -> Result<(), Error>
Sets current thread’s priority to this value.
Trait Implementations
sourceimpl Clone for ThreadPriority
impl Clone for ThreadPriority
sourcefn clone(&self) -> ThreadPriority
fn clone(&self) -> ThreadPriority
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ThreadPriority
impl Debug for ThreadPriority
sourceimpl Hash for ThreadPriority
impl Hash for ThreadPriority
sourceimpl Ord for ThreadPriority
impl Ord for ThreadPriority
sourceimpl PartialEq<ThreadPriority> for ThreadPriority
impl PartialEq<ThreadPriority> for ThreadPriority
sourcefn eq(&self, other: &ThreadPriority) -> bool
fn eq(&self, other: &ThreadPriority) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ThreadPriority) -> bool
fn ne(&self, other: &ThreadPriority) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ThreadPriority> for ThreadPriority
impl PartialOrd<ThreadPriority> for ThreadPriority
sourcefn partial_cmp(&self, other: &ThreadPriority) -> Option<Ordering>
fn partial_cmp(&self, other: &ThreadPriority) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl TryFrom<u8> for ThreadPriority
impl TryFrom<u8> for ThreadPriority
impl Copy for ThreadPriority
impl Eq for ThreadPriority
impl StructuralEq for ThreadPriority
impl StructuralPartialEq for ThreadPriority
Auto Trait Implementations
impl RefUnwindSafe for ThreadPriority
impl Send for ThreadPriority
impl Sync for ThreadPriority
impl Unpin for ThreadPriority
impl UnwindSafe for ThreadPriority
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more