Struct OwnedRwLockReadGuard

pub struct OwnedRwLockReadGuard<T, U = T>
where
    T: ?Sized,
    U: ?Sized,
{ /* private fields */ }

Available on crate features dep_tokio and std only.

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

This structure is created by the read_owned method on RwLock.

Implementations

impl<T, U> OwnedRwLockReadGuard<T, U>

where T: ?Sized, U: ?Sized,

pub fn map<F, V>( this: OwnedRwLockReadGuard<T, U>, f: F, ) -> OwnedRwLockReadGuard<T, V>

where F: FnOnce(&U) -> &V, V: ?Sized,

Makes a new OwnedRwLockReadGuard for a component of the locked data. This operation cannot fail as the OwnedRwLockReadGuard passed in already locked the data.

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

Examples

use std::sync::Arc;
use tokio::sync::{RwLock, OwnedRwLockReadGuard};

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

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

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

assert_eq!(1, *guard);

pub fn try_map<F, V>( this: OwnedRwLockReadGuard<T, U>, f: F, ) -> Result<OwnedRwLockReadGuard<T, V>, OwnedRwLockReadGuard<T, U>>

where F: FnOnce(&U) -> Option<&V>, V: ?Sized,

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

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

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

Examples

use std::sync::Arc;
use tokio::sync::{RwLock, OwnedRwLockReadGuard};

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

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

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

assert_eq!(1, *guard);

pub fn rwlock(this: &OwnedRwLockReadGuard<T, U>) -> &Arc<RwLock<T>>

Returns a reference to the original Arc<RwLock>.

Examples

use std::sync::Arc;
use tokio::sync::{RwLock, OwnedRwLockReadGuard};

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

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

let guard = lock.clone().read_owned().await;
assert!(Arc::ptr_eq(&lock, OwnedRwLockReadGuard::rwlock(&guard)));

let guard = OwnedRwLockReadGuard::map(guard, |f| &f.0);
assert!(Arc::ptr_eq(&lock, OwnedRwLockReadGuard::rwlock(&guard)));

Trait Implementations

impl<T, U> Debug for OwnedRwLockReadGuard<T, U>

where U: Debug + ?Sized, T: ?Sized,

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

Formats the value using the given formatter.

impl<T, U> Deref for OwnedRwLockReadGuard<T, U>

where T: ?Sized, U: ?Sized,

type Target = U

The resulting type after dereferencing.

fn deref(&self) -> &U

Dereferences the value.

impl<T, U> Display for OwnedRwLockReadGuard<T, U>

where U: Display + ?Sized, T: ?Sized,

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

Formats the value using the given formatter.

impl<T, U> Drop for OwnedRwLockReadGuard<T, U>

where T: ?Sized, U: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, U> Send for OwnedRwLockReadGuard<T, U>

where T: Send + Sync + ?Sized, U: Sync + ?Sized,

impl<T, U> Sync for OwnedRwLockReadGuard<T, U>

where T: Send + Sync + ?Sized, U: Send + Sync + ?Sized,