Struct ruspiro_lock::DataLock

#[repr(C)]
pub struct DataLock<T> { /* fields omitted */ }

An exclusive access lock around the given data

Methods

impl<T> DataLock<T>

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

Create a new data access guarding lock

pub fn try_lock(&self) -> Option<TryDataLock<T>>

Try to lock the guarded data for mutual exclusive access. Returns None if the lock failes or Some(TryDataLock). The actual data, the TryDataLock wraps could be conviniently accessed by dereferencing it.

Example

static DATA: DataLock<u32> = DataLock::new(10);
    if let Some(data) = DATA.try_lock() {
        // do something with data
    }

pub fn lock(&self) -> TryDataLock<T>

Lock the guarded data for mutual exclusive access. This blocks until the data could be successfully locked. The locked data will be returned as TryDataLock. Simply derefrencing this allows access to the contained data value.

Example

static DATA: DataLock<u32> = DataLock::new(10);
    let mut data = DATA.lock();
    // do something with data
    *data = 15;

Trait Implementations

impl<T: Debug> Debug for DataLock<T>

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

Formats the value using the given formatter.

impl<T> Send for DataLock<T>

impl<T> Sync for DataLock<T>