Struct axsync::Mutex

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

Available on crate feature multitask only.

A mutual exclusion primitive useful for protecting shared data, similar to std::sync::Mutex.

When the mutex is locked, the current task will block and be put into the wait queue. When the mutex is unlocked, all tasks waiting on the queue will be woken up.

Implementations

impl<T> Mutex<T>

pub const fn new(data: T) -> Self

Creates a new Mutex wrapping the supplied data.

pub fn into_inner(self) -> T

Consumes this Mutex and unwraps the underlying data.

impl<T: ?Sized> Mutex<T>

pub fn is_locked(&self) -> bool

Returns true if the lock is currently held.

Safety

This function provides no synchronization guarantees and so its result should be considered ‘out of date’ the instant it is called. Do not use it for synchronization purposes. However, it may be useful as a heuristic.

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

Locks the Mutex and returns a guard that permits access to the inner data.

The returned value may be dereferenced for data access and the lock will be dropped when the guard falls out of scope.

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

Try to lock this Mutex, returning a lock guard if successful.

pub unsafe fn force_unlock(&self)

Force unlock the Mutex.

Safety

This is extremely unsafe if the lock is not held by the current thread. However, this can be useful in some instances for exposing the lock to FFI that doesn’t know how to deal with RAII.

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

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, and a mutable reference is guaranteed to be exclusive in Rust, no actual locking needs to take place – the mutable borrow statically guarantees no locks exist. As such, this is a ‘zero-cost’ operation.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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