Struct fast_async_mutex::mutex::Mutex

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

The simple Mutex, which will provide unique access to you data between multiple threads/futures.

Implementations

impl<T> Mutex<T>

pub const fn new(data: T) -> Mutex<T>

Create a new Mutex

impl<T: ?Sized> Mutex<T>

pub const fn lock(&self) -> MutexGuardFuture<'_, T>

Acquires the mutex.

Returns a guard that releases the mutex and wake the next locker when dropped.

Examples

use fast_async_mutex::mutex::Mutex;

#[tokio::main]
async fn main() {
    let mutex = Mutex::new(10);
    let guard = mutex.lock().await;
    assert_eq!(*guard, 10);
}

pub fn lock_owned(self: &Arc<Self>) -> MutexOwnedGuardFuture<T>

Acquires the mutex.

Returns a guard that releases the mutex and wake the next locker when dropped. MutexOwnedGuardFuture have a 'static lifetime, but requires the Arc<Mutex<T>> type

Examples

use fast_async_mutex::mutex::Mutex;
use std::sync::Arc;
#[tokio::main]
async fn main() {
    let mutex = Arc::new(Mutex::new(10));
    let guard = mutex.lock_owned().await;
    assert_eq!(*guard, 10);
}

Trait Implementations

impl<T: Debug + ?Sized> Debug for Mutex<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Send for Mutex<T> where
    T: Send, 

impl<T: ?Sized> Sync for Mutex<T> where
    T: Send + Sync,