Struct futures::lock::MutexGuard

source ·
pub struct MutexGuard<'a, T>
where T: ?Sized,
{ /* private fields */ }
Expand description

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§

source§

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

source

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

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

Example
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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Auto Trait Implementations§

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 T
where 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<T, U> TryFrom<U> for T
where U: Into<T>,

§

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 T
where U: TryFrom<T>,

§

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.