Struct Mutex 

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

Represents an object which is protected by a FreeRTOS recursive mutex.

Implementations

impl<T> Mutex<T>

Provides a constant-period looping construct.

pub fn new(data: T) -> Self

Creates a new mutex which wraps the given object. Panics on failure; see Mutex::try_new().

pub fn try_new(data: T) -> Result<Self, Error>

Creates a new mutex which wraps the given object.

impl<T: ?Sized> Mutex<T>

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

Obtains a MutexGuard giving access to the object protected by the mutex. Blocks until access can be obtained. Panics on failure; see Mutex::try_lock().

Behaviour

This function is blocking; it does not return until the the mutex is taken by the task, and allows other tasks to run in the meantime. Further, the task which currently holds the mutex actually inherits the current task’s priority, if it is higher; this prevents a high-priority task from being slowed down by waiting for a resource held by a low-priority task. See this documentation from FreeRTOS for details.

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

Obtains a MutexGuard giving access to the object protected by the mutex. Blocks until access can be obtained; see Mutex::lock() for a more thorough behavioural description.

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

Obtains a MutexGuard giving access to the object protected by the mutex, if it is available immediately. Does not block.

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> Drop for Mutex<T>

fn drop(&mut self)

Executes the destructor for this type.

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

fn from(data: T) -> Self

Converts to this type from the input type.

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

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