Struct RwLock 

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

An async reader-writer lock: .read().await/.write().await yield the calling task rather than blocking the OS thread while contended.

Implementations

impl<T> RwLock<T>

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

Create a new lock guarding data, initially unlocked.

pub fn into_inner(self) -> T

Consume the lock, returning the guarded value.

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

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

Acquire a shared read lock, waiting while a writer holds it. Multiple readers may hold the lock concurrently.

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

Acquire the exclusive write lock, waiting while any reader or writer holds it.

impl<T: ?Sized> RwLock<T>

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

Acquire a read lock if immediately available, without waiting.

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

Acquire the write lock if immediately available, without waiting.

pub const fn get_mut(&mut self) -> &mut T

Get mutable access to the guarded value without locking — sound because &mut self statically proves no other reference exists.

Trait Implementations

impl<T: Default> Default for RwLock<T>

fn default() -> Self

Returns the “default value” for a type.

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

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