Struct sc_consensus::shared_data::SharedDataLocked

pub struct SharedDataLocked<'a, T> { /* fields omitted */ }

Created by SharedData::shared_data_locked.

As long as this object isn’t dropped, the shared data is held in a mutex guard and the shared data is tagged as locked. Access to the shared data is provided through Deref and DerefMut. The trick is to use Self::release_mutex to release the mutex, but still keep the shared data locked. This means every other thread trying to access the shared data in this time will need to wait until this lock is freed.

If this object is dropped without calling Self::release_mutex, the lock will be dropped immediately.

Implementations

impl<'a, T> SharedDataLocked<'a, T>

pub fn release_mutex(self) -> SharedDataLockedUpgradable<T>

Release the mutex, but keep the shared data locked.

Trait Implementations

impl<'a, T> Deref for SharedDataLocked<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> DerefMut for SharedDataLocked<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T> Drop for SharedDataLocked<'a, T>

fn drop(&mut self)

Executes the destructor for this type.