Struct MutexGuard

struct MutexGuard<'a, T: ?Sized + 'a> { ... }

An RAII implementation of a "scoped lock" of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.

The data protected by the mutex can be accessed through this guard via its Deref and DerefMut implementations.

This structure is created by the lock and try_lock methods on Mutex.

Implementations

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

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

Makes a MappedMutexGuard for a component of the borrowed data, e.g. an enum variant.

The Mutex is already locked, so this cannot fail.

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

fn filter_map<U, F>(orig: Self, f: F) -> Result<MappedMutexGuard<'a, U>, Self>
where
    F: FnOnce(&mut T) -> Option<&mut U>,
    U: ?Sized

Makes a MappedMutexGuard for a component of the borrowed data. The original guard is returned as an Err(...) if the closure returns None.

The Mutex is already locked, so this cannot fail.

This is an associated function that needs to be used as MutexGuard::filter_map(...). A method would interfere with methods of the same name on the contents of the MutexGuard used through Deref.

impl<'a, T> Freeze for MutexGuard<'a, T>

impl<'a, T> RefUnwindSafe for MutexGuard<'a, T>

impl<'a, T> Unpin for MutexGuard<'a, T>

impl<'a, T> UnsafeUnpin for MutexGuard<'a, T>

impl<'a, T> UnwindSafe for MutexGuard<'a, T>

impl<P, T> Receiver for MutexGuard<'a, T>

impl<T> Any for MutexGuard<'a, T>

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for MutexGuard<'a, T>

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for MutexGuard<'a, T>

fn borrow_mut(self: &mut Self) -> &mut T

impl<T> From for MutexGuard<'a, T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToString for MutexGuard<'a, T>

fn to_string(self: &Self) -> String

impl<T, U> Into for MutexGuard<'a, T>

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for MutexGuard<'a, T>

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for MutexGuard<'a, T>

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T: ?Sized + Sync> Sync for MutexGuard<'_, T>

impl<T: ?Sized + fmt::Debug> Debug for MutexGuard<'_, T>

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

impl<T: ?Sized + fmt::Display> Display for MutexGuard<'_, T>

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

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

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

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

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

impl<T: ?Sized> Drop for MutexGuard<'_, T>

fn drop(self: &mut Self)

impl<T: ?Sized> Send for MutexGuard<'_, T>