Struct holochain::prelude::dependencies::kitsune_p2p_types::dependencies::lair_keystore_api::dependencies::tokio::sync::OwnedRwLockWriteGuard
source · pub struct OwnedRwLockWriteGuard<T>where
T: ?Sized,{ /* private fields */ }
Expand description
Owned RAII structure used to release the exclusive write access of a lock when dropped.
This structure is created by the write_owned
method
on RwLock
.
Implementations§
source§impl<T> OwnedRwLockWriteGuard<T>where
T: ?Sized,
impl<T> OwnedRwLockWriteGuard<T>where T: ?Sized,
sourcepub fn map<F, U>(
this: OwnedRwLockWriteGuard<T>,
f: F
) -> OwnedRwLockMappedWriteGuard<T, U>where
F: FnOnce(&mut T) -> &mut U,
U: ?Sized,
pub fn map<F, U>( this: OwnedRwLockWriteGuard<T>, f: F ) -> OwnedRwLockMappedWriteGuard<T, U>where F: FnOnce(&mut T) -> &mut U, U: ?Sized,
Makes a new OwnedRwLockMappedWriteGuard
for a component of the locked
data.
This operation cannot fail as the OwnedRwLockWriteGuard
passed in
already locked the data.
This is an associated function that needs to be used as
OwnedRwLockWriteGuard::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, OwnedRwLockWriteGuard};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct Foo(u32);
let lock = Arc::new(RwLock::new(Foo(1)));
{
let lock = Arc::clone(&lock);
let mut mapped = OwnedRwLockWriteGuard::map(lock.write_owned().await, |f| &mut f.0);
*mapped = 2;
}
assert_eq!(Foo(2), *lock.read().await);
sourcepub fn downgrade_map<F, U>(
this: OwnedRwLockWriteGuard<T>,
f: F
) -> OwnedRwLockReadGuard<T, U>where
F: FnOnce(&T) -> &U,
U: ?Sized,
pub fn downgrade_map<F, U>( this: OwnedRwLockWriteGuard<T>, f: F ) -> OwnedRwLockReadGuard<T, U>where F: FnOnce(&T) -> &U, U: ?Sized,
Makes a new OwnedRwLockReadGuard
for a component of the locked data.
This operation cannot fail as the OwnedRwLockWriteGuard
passed in already
locked the data.
This is an associated function that needs to be used as
OwnedRwLockWriteGuard::downgrade_map(..)
. A method would interfere with methods of
the same name on the contents of the locked data.
Inside of f
, you retain exclusive access to the data, despite only being given a &T
. Handing out a
&mut T
would result in unsoundness, as you could use interior mutability.
Examples
use std::sync::Arc;
use tokio::sync::{RwLock, OwnedRwLockWriteGuard};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct Foo(u32);
let lock = Arc::new(RwLock::new(Foo(1)));
let guard = Arc::clone(&lock).write_owned().await;
let mapped = OwnedRwLockWriteGuard::downgrade_map(guard, |f| &f.0);
let foo = lock.read_owned().await;
assert_eq!(foo.0, *mapped);
sourcepub fn try_map<F, U>(
this: OwnedRwLockWriteGuard<T>,
f: F
) -> Result<OwnedRwLockMappedWriteGuard<T, U>, OwnedRwLockWriteGuard<T>>where
F: FnOnce(&mut T) -> Option<&mut U>,
U: ?Sized,
pub fn try_map<F, U>( this: OwnedRwLockWriteGuard<T>, f: F ) -> Result<OwnedRwLockMappedWriteGuard<T, U>, OwnedRwLockWriteGuard<T>>where F: FnOnce(&mut T) -> Option<&mut U>, U: ?Sized,
Attempts to make a new OwnedRwLockMappedWriteGuard
for a component
of the locked data. The original guard is returned if the closure
returns None
.
This operation cannot fail as the OwnedRwLockWriteGuard
passed in
already locked the data.
This is an associated function that needs to be
used as OwnedRwLockWriteGuard::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, OwnedRwLockWriteGuard};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct Foo(u32);
let lock = Arc::new(RwLock::new(Foo(1)));
{
let guard = Arc::clone(&lock).write_owned().await;
let mut guard = OwnedRwLockWriteGuard::try_map(guard, |f| Some(&mut f.0)).expect("should not fail");
*guard = 2;
}
assert_eq!(Foo(2), *lock.read().await);
sourcepub fn try_downgrade_map<F, U>(
this: OwnedRwLockWriteGuard<T>,
f: F
) -> Result<OwnedRwLockReadGuard<T, U>, OwnedRwLockWriteGuard<T>>where
F: FnOnce(&T) -> Option<&U>,
U: ?Sized,
pub fn try_downgrade_map<F, U>( this: OwnedRwLockWriteGuard<T>, f: F ) -> Result<OwnedRwLockReadGuard<T, U>, OwnedRwLockWriteGuard<T>>where F: FnOnce(&T) -> Option<&U>, U: ?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 OwnedRwLockWriteGuard
passed in already
locked the data.
This is an associated function that needs to be
used as OwnedRwLockWriteGuard::try_downgrade_map(...)
. A method would interfere with
methods of the same name on the contents of the locked data.
Inside of f
, you retain exclusive access to the data, despite only being given a &T
. Handing out a
&mut T
would result in unsoundness, as you could use interior mutability.
If this function returns Err(...)
, the lock is never unlocked nor downgraded.
Examples
use std::sync::Arc;
use tokio::sync::{RwLock, OwnedRwLockWriteGuard};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
struct Foo(u32);
let lock = Arc::new(RwLock::new(Foo(1)));
let guard = Arc::clone(&lock).write_owned().await;
let guard = OwnedRwLockWriteGuard::try_downgrade_map(guard, |f| Some(&f.0)).expect("should not fail");
let foo = lock.read_owned().await;
assert_eq!(foo.0, *guard);
sourcepub fn into_mapped(
this: OwnedRwLockWriteGuard<T>
) -> OwnedRwLockMappedWriteGuard<T, T>
pub fn into_mapped( this: OwnedRwLockWriteGuard<T> ) -> OwnedRwLockMappedWriteGuard<T, T>
Converts this OwnedRwLockWriteGuard
into an
OwnedRwLockMappedWriteGuard
. This method can be used to store a
non-mapped guard in a struct field that expects a mapped guard.
This is equivalent to calling OwnedRwLockWriteGuard::map(guard, |me| me)
.
sourcepub fn downgrade(self) -> OwnedRwLockReadGuard<T, T>
pub fn downgrade(self) -> OwnedRwLockReadGuard<T, T>
Atomically downgrades a write lock into a read lock without allowing any writers to take exclusive access of the lock in the meantime.
Note: This won’t necessarily allow any additional readers to acquire
locks, since RwLock
is fair and it is possible that a writer is next
in line.
Returns an RAII guard which will drop this read access of the RwLock
when dropped.
Examples
let lock = Arc::new(RwLock::new(1));
let n = lock.clone().write_owned().await;
let cloned_lock = lock.clone();
let handle = tokio::spawn(async move {
*cloned_lock.write_owned().await = 2;
});
let n = n.downgrade();
assert_eq!(*n, 1, "downgrade is atomic");
drop(n);
handle.await.unwrap();
assert_eq!(*lock.read().await, 2, "second writer obtained write lock");
Trait Implementations§
source§impl<T> Deref for OwnedRwLockWriteGuard<T>where
T: ?Sized,
impl<T> Deref for OwnedRwLockWriteGuard<T>where T: ?Sized,
source§impl<T> DerefMut for OwnedRwLockWriteGuard<T>where
T: ?Sized,
impl<T> DerefMut for OwnedRwLockWriteGuard<T>where T: ?Sized,
source§impl<T> Drop for OwnedRwLockWriteGuard<T>where
T: ?Sized,
impl<T> Drop for OwnedRwLockWriteGuard<T>where T: ?Sized,
impl<T> Send for OwnedRwLockWriteGuard<T>where T: Send + Sync + ?Sized,
impl<T> Sync for OwnedRwLockWriteGuard<T>where T: Send + Sync + ?Sized,
Auto Trait Implementations§
impl<T> !RefUnwindSafe for OwnedRwLockWriteGuard<T>
impl<T: ?Sized> Unpin for OwnedRwLockWriteGuard<T>where T: Unpin,
impl<T> !UnwindSafe for OwnedRwLockWriteGuard<T>
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata ) -> <T as Pointee>::Metadata
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,
§fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut D ) -> Result<With<T, W>, <D as Fallible>::Error>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.