Struct spin::rwlock::RwLockWriteGuard

pub struct RwLockWriteGuard<'a, T: 'a + ?Sized, R = Spin> { /* private fields */ }

Available on crate feature rwlock only.

A guard that provides mutable data access.

When the guard falls out of scope it will release the lock.

Implementations

impl<'rwlock, T: ?Sized, R> RwLockWriteGuard<'rwlock, T, R>

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

Downgrades the writable lock guard to a readable, shared lock guard. Cannot fail and is guaranteed not to spin.

let mylock = spin::RwLock::new(0);

let mut writable = mylock.write();
*writable = 1;

let readable = writable.downgrade(); // This is guaranteed not to spin
assert_eq!(*readable, 1);

pub fn downgrade_to_upgradeable(self) -> RwLockUpgradableGuard<'rwlock, T, R>

Downgrades the writable lock guard to an upgradable, shared lock guard. Cannot fail and is guaranteed not to spin.

let mylock = spin::RwLock::new(0);

let mut writable = mylock.write();
*writable = 1;

let readable = writable.downgrade_to_upgradeable(); // This is guaranteed not to spin
assert_eq!(*readable, 1);

pub fn leak(this: Self) -> &'rwlock mut T

Leak the lock guard, yielding a mutable reference to the underlying data.

Note that this function will permanently lock the original lock.

let mylock = spin::RwLock::new(0);

let data: &mut i32 = spin::RwLockWriteGuard::leak(mylock.write());

*data = 1;
assert_eq!(*data, 1);

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.