Struct MutexGuard

#[must_use = "if unused the Mutex will immediately unlock"]
pub struct MutexGuard<'a, T: ?Sized + 'a> { pub(in ::sync::nonpoison::mutex) lock: &'a Mutex<T> }

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.

Fields

lock: &'a Mutex<T>

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<'mutex, T: ?Sized> MutexGuard<'mutex, T>

unsafe fn new(lock: &'mutex Mutex<T>) -> MutexGuard<'mutex, T>

Trait Implementations

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

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

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

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

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

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

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

type Target = T;
fn deref(&self) -> &T

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

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

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

fn drop(&mut self)

Auto Trait Implementations

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

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

impl<'a, T> Freeze for MutexGuard<'a, T> where &'a Mutex<T>: Freeze, T: ?Sized,

impl<'a, T> Unpin for MutexGuard<'a, T> where &'a Mutex<T>: Unpin, T: ?Sized,

impl<'a, T> UnsafeUnpin for MutexGuard<'a, T> where &'a Mutex<T>: UnsafeUnpin, T: ?Sized,

Blanket Implementations

impl<P, T> Receiver for MutexGuard<'a, T> where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T;

impl<T> Any for MutexGuard<'a, T> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for MutexGuard<'a, T> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for MutexGuard<'a, T> where T: ?Sized,

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

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

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> SizeHint for MutexGuard<'a, T> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

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

impl<T> ToString for MutexGuard<'a, T> where T: Display + ?Sized,

fn to_string(&self) -> String

impl<T, U> Into<U> for MutexGuard<'a, T> where U: From<T>,

fn into(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<U> for MutexGuard<'a, T> where U: Into<T>,

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

impl<T, U> TryInto<U> for MutexGuard<'a, T> where U: TryFrom<T>,

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