[][src]Struct futures::lock::Mutex

pub struct Mutex<T> where
    T: ?Sized
{ /* fields omitted */ }

A futures-aware mutex.

Methods

impl<T> Mutex<T>[src]

pub fn new(t: T) -> Mutex<T>[src]

Creates a new futures-aware mutex.

pub fn into_inner(self) -> T[src]

Consumes this mutex, returning the underlying data.

Examples

use futures::lock::Mutex;

let mutex = Mutex::new(0);
assert_eq!(mutex.into_inner(), 0);

impl<T> Mutex<T> where
    T: ?Sized
[src]

pub fn try_lock(&self) -> Option<MutexGuard<T>>[src]

Attempt to acquire the lock immediately.

If the lock is currently held, this will return None.

Important traits for MutexLockFuture<'a, T>
pub fn lock(&self) -> MutexLockFuture<T>[src]

Acquire the lock asynchronously.

This method returns a future that will resolve once the lock has been successfully acquired.

Important traits for &'_ mut F
pub fn get_mut(&mut self) -> &mut T[src]

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, no actual locking needs to take place -- the mutable borrow statically guarantees no locks exist.

Examples

use futures::lock::Mutex;

let mut mutex = Mutex::new(0);
*mutex.get_mut() = 10;
assert_eq!(*mutex.lock().await, 10);

Trait Implementations

impl<T> Sync for Mutex<T> where
    T: Send + ?Sized
[src]

impl<T> Default for Mutex<T> where
    T: Default
[src]

impl<T> Debug for Mutex<T> where
    T: ?Sized
[src]

impl<T> Send for Mutex<T> where
    T: Send + ?Sized
[src]

impl<T> From<T> for Mutex<T>[src]

Auto Trait Implementations

impl<T: ?Sized> Unpin for Mutex<T> where
    T: Unpin

impl<T: ?Sized> UnwindSafe for Mutex<T> where
    T: UnwindSafe

impl<T> !RefUnwindSafe for Mutex<T>

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]