Enum RunLevel 

#[non_exhaustive]
pub enum RunLevel {
    ThreadMode,
    Interrupt(ElevatedRunLevel),
}

Represents the priority level of running code.

Interrupts at or below this level are masked.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ThreadMode

Thread mode.

This is the lowest level. No interrupts are masked by the run level.

Interrupt(ElevatedRunLevel)

An elevated level, usually an interrupt handler’s.

Implementations

impl RunLevel

pub fn current() -> Self

Returns the current run level.

Examples

use esp_hal::interrupt::RunLevel;

let level = RunLevel::current();
println!("Current run level: {:?}", level);

pub unsafe fn change(to: Self) -> Self

Available on crate feature unstable only.

Changes the current run level to the specified level and returns the previous level.

Safety

This function must only be used to raise the run level and to restore it to a previous value. It must not be used to arbitrarily lower the run level.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn is_thread(&self) -> bool

Checks if the run level indicates thread mode.

This function can be used to determine if the CPU is executing an interrupt handler.

Examples

use esp_hal::interrupt::RunLevel;

let level = RunLevel::current();

if level.is_thread() {
    println!("Running in thread mode");
} else {
    println!("Running in an interrupt handler");
}

Trait Implementations

impl Clone for RunLevel

fn clone(&self) -> RunLevel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunLevel

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

Formats the value using the given formatter.

impl From<RunLevel> for u32

fn from(level: RunLevel) -> Self

Converts to this type from the input type.

impl Ord for RunLevel

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

fn eq(&self, other: &ElevatedRunLevel) -> 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 PartialEq<Priority> for RunLevel

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

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

fn partial_cmp(&self, other: &RunLevel) -> 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<u32> for RunLevel

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

type Error = PriorityError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for RunLevel

impl Eq for RunLevel

impl StructuralPartialEq for RunLevel