Struct RestoreState

pub struct RestoreState(/* private fields */);

Opaque “restore state”.

Implementations use this to “carry over” information between acquiring and releasing a critical section. For example, when nesting two critical sections of an implementation that disables interrupts globally, acquiring the inner one won’t disable the interrupts since they’re already disabled. The impl would use the restore state to “tell” the corresponding release that it does not have to reenable interrupts yet, only the outer release should do so.

User code uses RestoreState opaquely, critical section implementations use RawRestoreState so that they can use the inner value.

Implementations

impl RestoreState

pub const fn invalid() -> Self

Create an invalid, dummy RestoreState.

This can be useful to avoid Option when storing a RestoreState in a struct field, or a static.

Note that due to the safety contract of acquire/release, you must not pass a RestoreState obtained from this method to release.

Trait Implementations

impl Clone for RestoreState

fn clone(&self) -> RestoreState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RestoreState

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

Formats the value using the given formatter.

impl Copy for RestoreState