Struct ruspiro_lock::sync::RWLock

#[repr(C, align(16))]
pub struct RWLock<T: ?Sized> { /* fields omitted */ }

An exclusive access lock around the given data

Implementations

impl<T> RWLock<T>

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

Create a new data access guarding lock.

pub fn try_lock(&self) -> Option<WriteLockGuard<'_, T>>

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

pub fn lock(&self) -> WriteLockGuard<'_, T>

Lock the guarded data for mutual exclusive access. This blocks until the data could be successfully locked. This also implies that there is no concurrent ReadLockGuard existing. The locked data will be returned as WriteLockGuard. Simply derefrencing this allows access to the contained data value.

pub fn try_read(&self) -> Option<ReadLockGuard<'_, T>>

Provide a ReadLock to the wrapped data. This call blocks until the recource is available. There can be as many concurrent ReadLockGuards being handed out if there is no WriteLockGuard to the same resource already existing.

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

Provide a ReadLock to the wrapped data. This call blocks until the recource is available. There can be as many concurrent ReadLockGuards being handed out if there is no WriteLockGuard to the same resource already existing.

pub unsafe fn as_ref_unchecked(&self) -> &T

Provide an immutable borrow to the data secured by the RWLock.

Safety

This is only safe if it is guarantied that there is exactly only one call to this function or any other accessor of the RWLock until the returned borrow goes out of scope.

pub fn into_inner(self) -> T where
    T: Sized, 

Consume the Mutex and return the inner value

Trait Implementations

impl<T> Debug for RWLock<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Sync for RWLock<T>

The RWLock is always Sync, to make it Send as well it need to be wrapped into an Arc.