Struct MutexRegister 

pub struct MutexRegister<T: Copy + Default> { /* private fields */ }

An shared-memory register, backed by a Mutex.

This object uses a mutex to protect against concurrent memory access. It is not lock-free.

Examples

A simple spinlock.

use std::sync::Arc;
use std::{hint, thread};
use todc_mem::register::{MutexRegister, Register};


let register: Arc<MutexRegister<bool>> = Arc::new(MutexRegister::new());

let register_clone = register.clone();
let thread = thread::spawn(move || {
    register_clone.write(true)
});

while !register.read() {
    hint::spin_loop();
}

thread.join().unwrap();

It is also possible to store larger, more complicated objects.

use todc_mem::register::{MutexRegister, Register};

#[derive(Clone, Copy, Debug, Default, PartialEq)]
enum MyType {
    #[default]
    Nothing,
    Booleans([bool; 100]),
    Numbers([u64; 100]),
}

let register: MutexRegister<MyType> = MutexRegister::new();

assert_eq!(register.read(), MyType::Nothing);

let numbers = MyType::Numbers([42; 100]);
register.write(numbers);
assert_eq!(register.read(), numbers);

Trait Implementations

impl<T: Copy + Default> Clone for MutexRegister<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Copy + Default> Debug for MutexRegister<T>

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

Formats the value using the given formatter.

impl<T: Copy + Default> Default for MutexRegister<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + Default> Register for MutexRegister<T>

fn new() -> Self

Creates a new register containing the default value of T.

Examples

use todc_mem::register::{MutexRegister, Register};

let register: MutexRegister<bool> = MutexRegister::new();
assert_eq!(register.read(), bool::default());

fn read(&self) -> Self::Value

Returns the value currently contained in the register.

Examples

use todc_mem::register::{MutexRegister, Register};

let register: MutexRegister<bool> = MutexRegister::new();
assert_eq!(register.read(), false);

fn write(&self, value: Self::Value)

Sets contents of the register to the specified value.

Examples

use todc_mem::register::{MutexRegister, Register};

let register: MutexRegister<bool> = MutexRegister::new();
register.write(true);
assert_eq!(register.read(), true);

type Value = T