Struct async_std::sync::RwLockUpgradableReadGuard[−][src]

pub struct RwLockUpgradableReadGuard<'a, T> where
    T: ?Sized,  { /* fields omitted */ }

Expand description

A guard that releases the upgradable read lock when dropped.

Implementations

[src]

impl<'a, T> RwLockUpgradableReadGuard<'a, T> where
T: ?Sized,

[src]

pub fn downgrade(
guard: RwLockUpgradableReadGuard<'a, T>
) -> RwLockReadGuard<'a, T>

Downgrades into a regular reader guard.

Examples

use async_lock::{RwLock, RwLockUpgradableReadGuard};

let lock = RwLock::new(1);

let reader = lock.upgradable_read().await;
assert_eq!(*reader, 1);

assert!(lock.try_upgradable_read().is_none());

let reader = RwLockUpgradableReadGuard::downgrade(reader);

assert!(lock.try_upgradable_read().is_some());

[src]

pub fn try_upgrade(
guard: RwLockUpgradableReadGuard<'a, T>
) -> Result<RwLockWriteGuard<'a, T>, RwLockUpgradableReadGuard<'a, T>>

Attempts to upgrade into a write lock.

If a write lock could not be acquired at this time, then None is returned. Otherwise, an upgraded guard is returned that releases the write lock when dropped.

This function can only fail if there are other active read locks.

Examples

use async_lock::{RwLock, RwLockUpgradableReadGuard};

let lock = RwLock::new(1);

let reader = lock.upgradable_read().await;
assert_eq!(*reader, 1);

let reader2 = lock.read().await;
let reader = RwLockUpgradableReadGuard::try_upgrade(reader).unwrap_err();

drop(reader2);
let writer = RwLockUpgradableReadGuard::try_upgrade(reader).unwrap();

[src]

pub async fn upgrade(
guard: RwLockUpgradableReadGuard<'a, T>
) -> RwLockWriteGuard<'a, T>

Upgrades into a write lock.

Examples

use async_lock::{RwLock, RwLockUpgradableReadGuard};

let lock = RwLock::new(1);

let reader = lock.upgradable_read().await;
assert_eq!(*reader, 1);

let mut writer = RwLockUpgradableReadGuard::upgrade(reader).await;
*writer = 2;