Struct scrummage::Priority

pub struct Priority(_);

A prioritisation level

The priority of a Process controls how much CPU time it gets compared to other processes. Most programs don't need to be handled especially, and should be given a normal priority to allow the OS to handle scheduling

Implementations

impl Priority

pub fn normal() -> Self

The priority level given to normal processes; The default priority level.

assert_eq!(Process::current().priority().unwrap(), Priority::normal(),
           "I'm normal! Normal I tell you!");

pub fn higher(&self) -> impl Iterator<Item = Self>

Raise the priority level.

Be particularly careful with giving processes higher priority levels: Any process with a lower level will be halted until it pauses. Therefore, make sure any work it does is breif, and it uses OS APIs for delays (std::thread::sleep instead of loop {})

pub fn lower(&self) -> impl Iterator<Item = Self>

Lower the priority level.

Processes with lower priority levels will pause if other processes need to do work. They can be used for screen-savers e.t.c.

Trait Implementations

impl Debug for Priority

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

Formats the value using the given formatter.

impl Eq for Priority

impl Ord for Priority

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

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

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

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

This method tests for !=.

impl PartialOrd<Priority> for Priority

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

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

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

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

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

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

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

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

fn ge(&self, other: &Priority) -> bool

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

impl StructuralEq for Priority

impl StructuralPartialEq for Priority