Struct bare_metal::CriticalSection

pub struct CriticalSection<'cs> { /* private fields */ }

Critical section token.

An instance of this type indicates that the current core is executing code within a critical section. This means that no interrupts must be enabled that could preempt the currently running code.

Implementations

impl<'cs> CriticalSection<'cs>

pub unsafe fn new() -> Self

Creates a critical section token.

This method is meant to be used to create safe abstractions rather than being directly used in applications.

Safety

This must only be called when the current core is in a critical section. The caller must ensure that the returned instance will not live beyond the end of the critical section. Moreover, the caller must use adequate fences to prevent the compiler from moving the instructions inside the critical section to the outside of it. Sequentially consistent fences are suggested immediately after entry and immediately before exit from the critical section.

Note that the lifetime 'cs of the returned instance is unconstrained. User code must not be able to influence the lifetime picked for this type, since that might cause it to be inferred to 'static.

Trait Implementations

impl<'cs> Clone for CriticalSection<'cs>

fn clone(&self) -> CriticalSection<'cs>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'cs> Debug for CriticalSection<'cs>

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

Formats the value using the given formatter.

impl<'cs> Copy for CriticalSection<'cs>