Struct Mutex

pub struct Mutex<T> { /* private fields */ }

An async mutex

Locks will be acquired in the order they are requested

Examples

let mutex = Rc::new(Mutex::new(0));
screeps_async::spawn(async move {
    let mut val = mutex.lock().await;
    *val = 1;
}).detach();

Implementations

impl<T> Mutex<T>

pub fn new(val: T) -> Self

Construct a new Mutex in the unlocked state wrapping the given value

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

Acquire the mutex.

Returns a guard that release the mutex when dropped

pub fn try_lock(&self) -> Option<MutexGuard<'_, T>>

Try to acquire the mutex.

If the mutex could not be acquired at this time return None, otherwise returns a guard that will release the mutex when dropped.

pub fn into_inner(self) -> T

Consumes the mutex, returning the underlying data