Struct MutexGuard

pub struct MutexGuard<'a, T: ?Sized> { /* private fields */ }

An RAII guard returned by the lock and try_lock methods. When this structure is dropped (falls out of scope), the lock will be unlocked.

Implementations

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

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

Returns a locked view over a portion of the locked data.

Example

# futures::executor::block_on(async {
use futures::lock::{Mutex, MutexGuard};

let data = Mutex::new(Some("value".to_string()));
{
    let locked_str = MutexGuard::map(data.lock().await, |opt| opt.as_mut().unwrap());
    assert_eq!(&*locked_str, "value");
}
# });

Trait Implementations

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

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

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

impl<T: ?Sized + Sync> Sync 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, 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 = never;
fn try_from(value: U) -> Result<T, never>

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>