Struct ksched::sync::Mutex

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

An async mutex.

The locking mechanism uses a FIFO wait queue to avoid starvation.

Examples

use ksched::sync::Mutex;

let m: Mutex<usize> = Mutex::new(1);

let mut guard = m.lock().await;
*guard = 2;
drop(guard);

let guard = m.lock().await;
assert_eq!(*guard, 2);

Implementations

impl<T> Mutex<T>

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

Creates a new async mutex.

Examples

use ksched::sync::Mutex;

let mutex: Mutex<usize> = Mutex::new(0);

pub fn into_inner(self) -> T

Consumes the mutex, returning the underlying data.

Examples

use ksched::sync::Mutex;

let mutex: Mutex<usize> = Mutex::new(10);
assert_eq!(mutex.into_inner(), 10);

impl<T: ?Sized> Mutex<T>

pub async fn acquire(&self)

Acquire the mutex, which must be release manually by Self::release

pub unsafe fn release(&self)

Unlock manually.

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

Acquires the mutex.

Since inserting current task to the wait queue requires memory allocation, this function may return [AllocError] on oom. Otherwise, returns a guard that releases the mutex when dropped.

Examples

use ksched::sync::Mutex;

let mutex: Mutex<usize> = Mutex::new(10);
let guard = mutex.lock().await;
assert_eq!(*guard, 10);

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

Attempts to acquire the mutex.

If the mutex could not be acquired at this time, then None is returned. Otherwise, a guard is returned that releases the mutex when dropped.

Examples

use ksched::sync::Mutex;

let mutex = Mutex::new(10);
if let Some(guard) = mutex.try_lock() {
    assert_eq!(*guard, 10);
}

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

Since this call borrows the mutex mutably, no actual locking takes place – the mutable borrow statically guarantees the mutex is not already acquired.

Examples

use ksched::sync::Mutex;

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn default() -> Mutex<T>

Returns the “default value” for a type.

impl<T> From<T> for Mutex<T>

fn from(val: T) -> Mutex<T>

Performs the conversion.

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

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