Struct RwLock

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

An async RwLock

Locks will be acquired in the order they are requested. When any task is waiting on a write lock, no new read locks can be acquired

Implementations

impl<T> RwLock<T>

pub fn new(val: T) -> Self

Construct a new RwLock wrapping val

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

Block until the wrapped value can be immutably borrowed

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

Attempt to immutably borrow the wrapped value.

Returns None if the value is currently mutably borrowed or a task is waiting on a mutable reference.

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

Block until the wrapped value can be mutably borrowed

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

Attempt to mutably borrow the wrapped value.

Returns None if the value is already borrowed (mutably or immutably)

pub fn into_inner(self) -> T

Consumes this RwLock and returns ownership of the wrapped value

pub fn into_inner_rc(self: Rc<Self>) -> T

Convenience method to consume Rc<RwLock<T>> and return the wrapped value

Panics

This method panics if the Rc has more than one strong reference