Struct preemption::PreemptionGuard

pub struct PreemptionGuard { /* private fields */ }

A guard type that ensures preemption is disabled as long as it is held.

Call hold_preemption() to obtain a PreemptionGuard.

Preemption may be re-enabled when this guard is dropped, but not necessarily so, because other previous functions in the call stack may have already acquired a PreemptionGuard.

This type does not implement Send because it is invalid to move it across a “thread” boundary (into a different task). More specifically, it is invalid to move a PreemptionGuard across CPUs; this error condition is checked for when dropping it.

Implementations

impl PreemptionGuard

pub fn preemption_was_enabled(&self) -> bool

Returns whether preemption was originally enabled when this guard was created.

Return

• true: indicates that the caller function/task holding this guard was the one that caused the transition from preemption being enabled on this CPU to being disabled.
• false: indicates that preemption was already disabled and that no transition occurred when the caller function/task obtained this guard.

pub fn cpu_id(&self) -> CpuId

Returns the ID of the CPU on which this guard was created.

Trait Implementations

impl Debug for PreemptionGuard

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

Formats the value using the given formatter.

impl Drop for PreemptionGuard

fn drop(&mut self)

Executes the destructor for this type.

impl !Send for PreemptionGuard