W3cubDocs

/Rust

Struct MutexGuard 

pub struct MutexGuard<'a, T: ?Sized + 'a> { /* private fields */ }
🔬This is a nightly-only experimental API. (nonpoison_mutex #134645)

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

Source
impl<'a, T: ?Sized> MutexGuard<'a, T>
Source
pub fn map<U, F>(orig: Self, f: F) -> MappedMutexGuard<'a, U>where
    F: FnOnce(&mut T) -> &mut U,
    U: ?Sized,
🔬This is a nightly-only experimental API. (mapped_lock_guards #117108)

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.

Source
pub fn filter_map<U, F>(
    orig: Self,
    f: F,
) -> Result<MappedMutexGuard<'a, U>, Self>where
    F: FnOnce(&mut T) -> Option<&mut U>,
    U: ?Sized,
🔬This is a nightly-only experimental API. (mapped_lock_guards #117108)

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.

Trait Implementations

Source
impl<T: ?Sized + Debug> Debug for MutexGuard<'_, T>
Source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
Source
impl<T: ?Sized> Deref for MutexGuard<'_, T>
Source
type Target = T
The resulting type after dereferencing.
Source
fn deref(&self) -> &T
Dereferences the value.
Source
impl<T: ?Sized> DerefMut for MutexGuard<'_, T>
Source
fn deref_mut(&mut self) -> &mut T
Mutably dereferences the value.
Source
impl<T: ?Sized + Display> Display for MutexGuard<'_, T>
Source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
Source
impl<T: ?Sized> Drop for MutexGuard<'_, T>
Source
fn drop(&mut self)
Executes the destructor for this type. Read more
Source
impl<T: ?Sized> !Send for MutexGuard<'_, T>A MutexGuard is not Send to maximize platform portability.

On platforms that use POSIX threads (commonly referred to as pthreads) there is a requirement to release mutex locks on the same thread they were acquired. For this reason, MutexGuard must not implement Send to prevent it being dropped from another thread.

Source
impl<T: ?Sized + Sync> Sync for MutexGuard<'_, T>T must be Sync for a MutexGuard<T> to be Sync
because it is possible to get a &T from &MutexGuard (via Deref).

Auto Trait Implementations

impl<'a, T> Freeze for MutexGuard<'a, T>where
    T: ?Sized,
impl<'a, T> !RefUnwindSafe for MutexGuard<'a, T>
impl<'a, T> Unpin for MutexGuard<'a, T>where
    T: ?Sized,
impl<'a, T> !UnwindSafe for MutexGuard<'a, T>

Blanket Implementations

Source
impl<T> Any for Twhere
    T: 'static + ?Sized,
Source
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
Source
impl<T> Borrow<T> for Twhere
    T: ?Sized,
Source
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
Source
impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
Source
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source
impl<T> From<T> for T
Source
fn from(t: T) -> T

Returns the argument unchanged.

Source
impl<T, U> Into<U> for Twhere
    U: From<T>,
Source
fn into(self) -> U

Calls U::from(self).

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

Source
impl<P, T> Receiver for Pwhere
    P: Deref<Target = T> + ?Sized,
    T: ?Sized,
Source
type Target = T
🔬This is a nightly-only experimental API. (arbitrary_self_types #44874)
The target type on which the method may be called.
Source
impl<T> ToString for Twhere
    T: Display + ?Sized,
Source
fn to_string(&self) -> String
Converts the given value to a String. Read more
Source
impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,
Source
type Error = Infallible
The type returned in the event of a conversion error.
Source
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
Source
impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,
Source
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
Source
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/sync/nonpoison/struct.MutexGuard.html