Struct RwLockReadGuard

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

Available on crate feature sync only.

RAII structure used to release the shared read access of a lock when dropped.

This structure is created by the read method on RwLock.

Implementations

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

pub fn map<F, U: ?Sized>(this: Self, f: F) -> RwLockReadGuard<'a, U>

where F: FnOnce(&T) -> &U,

Makes a new RwLockReadGuard for a component of the locked data.

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

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

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

Examples

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

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

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

let guard = lock.read().await;
let guard = RwLockReadGuard::map(guard, |f| &f.0);

assert_eq!(1, *guard);

pub fn try_map<F, U: ?Sized>( this: Self, f: F, ) -> Result<RwLockReadGuard<'a, U>, Self>

where F: FnOnce(&T) -> Option<&U>,

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

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

This is an associated function that needs to be used as RwLockReadGuard::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 RwLockReadGuard::try_map from the parking_lot crate.

Examples

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

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

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

let guard = lock.read().await;
let guard = RwLockReadGuard::try_map(guard, |f| Some(&f.0)).expect("should not fail");

assert_eq!(1, *guard);

Trait Implementations

impl<'a, T> Debug for RwLockReadGuard<'a, T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T> Display for RwLockReadGuard<'a, T>

where T: Display + ?Sized,

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for RwLockReadGuard<'_, T>

where T: ?Sized + Sync,

impl<T> Sync for RwLockReadGuard<'_, T>

where T: ?Sized + Send + Sync,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.