Struct ksched::sync::RwLockWriteGuard

pub struct RwLockWriteGuard<'a, T: ?Sized>(_);

A guard that releases the write lock when dropped.

Implementations

impl<'a, T: ?Sized> RwLockWriteGuard<'a, T>

pub unsafe fn from_raw(lock: &'a RwLock<T>) -> Self

Create a writer guard without acquiring the lock.

You need to guarantee that you are actually the writer before.

pub fn downgrade(self) -> RwLockReadGuard<'a, T>

Downgrades into a regular reader guard.

Examples

use ksched::sync::{RwLock, RwLockWriteGuard};

let lock = RwLock::new(1);

let mut writer = lock.write().await;
*writer += 1;

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

let reader = RwLockWriteGuard::downgrade(writer);
assert_eq!(*reader, 2);

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

pub fn downgrade_to_upgradable(self) -> RwLockUpgradableReadGuard<'a, T>

Downgrades into an upgradable reader guard.

Examples

use ksched::sync::{RwLock, RwLockUpgradableReadGuard, RwLockWriteGuard};

let lock = RwLock::new(1);

let mut writer = lock.write().await;
*writer += 1;

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

let reader = RwLockWriteGuard::downgrade_to_upgradable(writer);
assert_eq!(*reader, 2);

assert!(lock.try_write().is_none());
assert!(lock.try_read().is_some());

assert!(RwLockUpgradableReadGuard::try_upgrade(reader).is_ok())

Trait Implementations

impl<T: Debug + ?Sized> Debug for RwLockWriteGuard<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for RwLockWriteGuard<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized> DerefMut for RwLockWriteGuard<'_, T>

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

Mutably dereferences the value.

impl<T: Display + ?Sized> Display for RwLockWriteGuard<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for RwLockWriteGuard<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send + ?Sized> Send for RwLockWriteGuard<'_, T>

impl<T: Sync + ?Sized> Sync for RwLockWriteGuard<'_, T>