Struct SharedMutex

pub struct SharedMutex<T: ?Sized> { /* private fields */ }

A lock providing both shared read locks and exclusive write locks.

Similar to std::sync::RwLock, except that its guards (SharedMutexReadGuard and SharedMutexWriteGuard) can wait on std::sync::Condvars, which is very useful for implementing efficient concurrent programs.

Another difference from std::sync::RwLock is that the guard types are Send.

Implementations

impl<T> SharedMutex<T>

pub fn new(value: T) -> Self

Create a new SharedMutex protecting the given value.

pub fn into_inner(self) -> LockResult<T>

Extract the data from the lock and destroy the lock.

Safe since it requires ownership of the lock.

impl<T: ?Sized> SharedMutex<T>

pub fn write(&self) -> LockResult<SharedMutexWriteGuard<'_, T>>

Acquire an exclusive Write lock on the data.

pub fn read(&self) -> LockResult<SharedMutexReadGuard<'_, T>>

Acquire a shared Read lock on the data.

pub fn try_read(&self) -> TryLockResult<SharedMutexReadGuard<'_, T>>

Attempt to acquire a shared Read lock on the data.

If acquiring the lock would block, returns TryLockError::WouldBlock.

pub fn try_write(&self) -> TryLockResult<SharedMutexWriteGuard<'_, T>>

Attempt to acquire an exclusive Write lock on the data.

If acquiring the lock would block, returns TryLockError::WouldBlock.

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

Get a mutable reference to the data without locking.

Safe since it requires exclusive access to the lock itself.

Trait Implementations

impl<T: ?Sized> AsMut<SharedMutex<T>> for Monitor<T>

fn as_mut(&mut self) -> &mut SharedMutex<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ?Sized> AsRef<SharedMutex<T>> for Monitor<T>

fn as_ref(&self) -> &SharedMutex<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ?Sized + Debug> Debug for SharedMutex<T>

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

Formats the value using the given formatter.

impl<T> Into<SharedMutex<T>> for Monitor<T>

fn into(self) -> SharedMutex<T>

Converts this type into the (usually inferred) input type.

impl<T: ?Sized + Send> Send for SharedMutex<T>

impl<T: ?Sized + Sync> Sync for SharedMutex<T>