Struct tokio::sync::RwLockMappedWriteGuard

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

RAII structure used to release the exclusive write access of a lock when dropped.

This structure is created by mapping an RwLockWriteGuard. It is a separate type from RwLockWriteGuard to disallow downgrading a mapped guard, since doing so can cause undefined behavior.

Implementations

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

pub fn map<F, U: ?Sized>(this: Self, f: F) -> RwLockMappedWriteGuard<'a, U> where
    F: FnOnce(&mut T) -> &mut U, 

Make a new RwLockMappedWriteGuard for a component of the locked data.

This operation cannot fail as the RwLockMappedWriteGuard passed in already locked the data.

This is an associated function that needs to be used as RwLockMappedWriteGuard::map(..). A method would interfere with methods of the same name on the contents of the locked data.

This is an asynchronous version of RwLockWriteGuard::map from the parking_lot crate.

Examples

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

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct Foo(u32);

let lock = RwLock::new(Foo(1));

{
    let mut mapped = RwLockWriteGuard::map(lock.write().await, |f| &mut f.0);
    *mapped = 2;
}

assert_eq!(Foo(2), *lock.read().await);

pub fn try_map<F, U: ?Sized>(
    this: Self,
    f: F
) -> Result<RwLockMappedWriteGuard<'a, U>, Self> where
    F: FnOnce(&mut T) -> Option<&mut U>, 

Attempts to make a new RwLockMappedWriteGuard for a component of the locked data. The original guard is returned if the closure returns None.

This operation cannot fail as the RwLockMappedWriteGuard passed in already locked the data.

This is an associated function that needs to be used as RwLockMappedWriteGuard::try_map(...). A method would interfere with methods of the same name on the contents of the locked data.

This is an asynchronous version of RwLockWriteGuard::try_map from the parking_lot crate.

Examples

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

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct Foo(u32);

let lock = RwLock::new(Foo(1));

{
    let guard = lock.write().await;
    let mut guard = RwLockWriteGuard::try_map(guard, |f| Some(&mut f.0)).expect("should not fail");
    *guard = 2;
}

assert_eq!(Foo(2), *lock.read().await);

Trait Implementations

impl<'a, T: ?Sized> Debug for RwLockMappedWriteGuard<'a, T> where
    T: Debug, 

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'a, T: ?Sized> Display for RwLockMappedWriteGuard<'a, T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<'a, T: ?Sized> Drop for RwLockMappedWriteGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized> Send for RwLockMappedWriteGuard<'_, T> where
    T: Send + Sync, 

impl<T: ?Sized> Sync for RwLockMappedWriteGuard<'_, T> where
    T: Send + Sync,