Struct shared_bus::AtomicCheckMutex

pub struct AtomicCheckMutex<BUS> { /* private fields */ }

A simple coherency checker for sharing across multiple tasks/threads.

This mutex type can be used when all bus users are contained in a single structure, and is intended for use with RTIC. When all bus users are contained within a structure managed by RTIC, RTIC will guarantee that bus collisions do not occur. To protect against accidentaly misuse, this mutex uses an atomic bool to determine when the bus is in use. If a bus collision is detected, the code will panic.

This mutex type is used with the BusManagerAtomicMutex type.

This manager type is explicitly safe to share across threads because it checks to ensure that collisions due to bus sharing do not occur.

Trait Implementations

impl<BUS> BusMutex for AtomicCheckMutex<BUS>

type Bus = BUS

The actual bus that is wrapped inside this mutex.

fn create(v: BUS) -> Self

Create a new mutex of this type.

fn lock<R, F: FnOnce(&mut Self::Bus) -> R>(&self, f: F) -> R

Lock the mutex and give a closure access to the bus inside.

impl<BUS: Debug> Debug for AtomicCheckMutex<BUS>

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

Formats the value using the given formatter.

impl<BUS> Sync for AtomicCheckMutex<BUS>