critical_section

Struct RestoreState

source
pub struct RestoreState(/* private fields */);
Expand description

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§

source§

impl RestoreState

source

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§

source§

impl Clone for RestoreState

source§

fn clone(&self) -> RestoreState

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RestoreState

source§

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

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

impl Copy for RestoreState

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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, 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.