Struct shuttle::sync::RwLock

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

A reader-writer lock, the same as std::sync::RwLock.

Unlike std::sync::RwLock, the same thread is never allowed to acquire the read side of a RwLock more than once. The std version is ambiguous about what behavior is allowed here, so we choose the most conservative one.

Implementations

impl<T> RwLock<T>

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

Create a new instance of an RwLock<T> which is unlocked.

impl<T: ?Sized> RwLock<T>

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

Locks this rwlock with shared read access, blocking the current thread until it can be acquired.

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

Locks this rwlock with exclusive write access, blocking the current thread until it can be acquired.

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

Attempts to acquire this rwlock with shared read access.

If the access could not be granted at this time, then Err is returned. This function does not block.

Note that unlike std::sync::RwLock::try_read, if the current thread already holds this read lock, try_read will return Err.

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

Attempts to acquire this rwlock with shared read access.

If the access could not be granted at this time, then Err is returned. This function does not block.

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

where T: Sized,

Consumes this RwLock, returning the underlying data

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for RwLock<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> RefUnwindSafe for RwLock<T>

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

impl<T: Send + ?Sized> Sync for RwLock<T>

impl<T: ?Sized> UnwindSafe for RwLock<T>