Struct OwnedMutexGuard 

pub struct OwnedMutexGuard<T: ?Sized> { /* private fields */ }

A proof of exclusive access that owns an Arc containing its Mutex.

Mutex::lock_owned and Mutex::try_lock_owned create this guard. Owning the Arc lets the guard outlive the reference used to acquire it; dropping the guard releases the lock and its share of the Arc.

Implementations

impl<T: ?Sized> OwnedMutexGuard<T>

pub fn map<U, F>(orig: Self, f: F) -> OwnedMappedMutexGuard<T, U>

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

Projects this guard to a mutable component of the protected value.

The returned guard retains the same Arc and keeps the mutex locked. Call this as OwnedMutexGuard::map(...) so a method named map on T remains accessible through deref.

Examples

use std::sync::Arc;

use asyncband::mutex::Mutex;
use asyncband::mutex::OwnedMutexGuard;

struct Config {
    name: String,
    value: u32,
}

let config = Config {
    name: "front size".to_owned(),
    value: 42,
};

let mutex = Arc::new(Mutex::new(config));
let guard = mutex.clone().lock_owned().await;

// Map to access only the value field
let value_guard = OwnedMutexGuard::map(guard, |config| &mut config.value);
assert_eq!(*value_guard, 42);

pub fn filter_map<U, F>( orig: Self, f: F, ) -> Result<OwnedMappedMutexGuard<T, U>, Self>

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

Attempts to project this guard to a mutable component of the protected value.

The original guard is returned when f returns None. Call this as OwnedMutexGuard::filter_map(...) so a method with the same name on T remains accessible.

Examples

use std::sync::Arc;

use asyncband::mutex::Mutex;
use asyncband::mutex::OwnedMutexGuard;

let data = vec![1, 2, 3, 4, 5];
let mutex = Arc::new(Mutex::new(data));
let guard = mutex.clone().lock_owned().await;

// Map to the first element
let first_guard =
    OwnedMutexGuard::filter_map(guard, |vec| vec.get_mut(0)).expect("vec should not be empty");

assert_eq!(*first_guard, 1);

Trait Implementations

impl<T: ?Sized + Debug> Debug for OwnedMutexGuard<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for OwnedMutexGuard<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized> DerefMut for OwnedMutexGuard<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: ?Sized + Display> Display for OwnedMutexGuard<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for OwnedMutexGuard<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: ?Sized + Send + Sync> Sync for OwnedMutexGuard<T>