Struct bare_metal::Mutex

pub struct Mutex<T> { /* fields omitted */ }

A "mutex" based on critical sections.

Safety

This Mutex is only safe on single-core systems.

On multi-core systems, a CriticalSection is not sufficient to ensure exclusive access.

Implementations

impl<T> Mutex<T>

pub const fn new(value: T) -> Self

Creates a new mutex.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the contained value when the mutex is already uniquely borrowed.

This does not require locking or a critical section since it takes &mut self, which guarantees unique ownership already. Care must be taken when using this method to unsafely access static mut variables, appropriate fences must be used to prevent unwanted optimizations.

pub fn into_inner(self) -> T

Unwraps the contained value, consuming the mutex.

pub fn borrow<'cs>(&'cs self, _cs: CriticalSection<'cs>) -> &'cs T

Borrows the data for the duration of the critical section.

Trait Implementations

impl<T: Debug> Debug for Mutex<T>

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

Formats the value using the given formatter.

impl<T> Sync for Mutex<T> where
    T: Send,