Skip to main content

UpgradableAsyncRwLock

Struct UpgradableAsyncRwLock 

Source
pub struct UpgradableAsyncRwLock<T> { /* private fields */ }
Expand description

A Tokio-based async rwlock with an upgradable read mode.

All write and upgradable_read acquisitions take an internal async mutex (“gate”) first. This ensures that upgrading from read to write does not allow another writer to slip in.

Implementations§

Source§

impl<T> UpgradableAsyncRwLock<T>

Source

pub fn new(value: T) -> Self

Create a new lock wrapping value.

Source

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

Acquire a shared read guard.

Source

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

Acquire an exclusive write guard.

Writers are serialized through the internal gate.

Source

pub async fn upgradable_read( &self, ) -> UpgradableAsyncRwLockUpgradableReadGuard<'_, T>

Acquire an upgradable read guard.

This allows shared reads, then a later UpgradableAsyncRwLockUpgradableReadGuard::upgrade to exclusive write while holding the same gate token.

Source

pub fn into_inner(self) -> T

Consume the lock and return the wrapped value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V