Skip to main content

MutexGuard

Struct MutexGuard 

Source
pub struct MutexGuard<'a, T: ?Sized + 'a> { /* private fields */ }
Expand description

Mutex types and guards for mutual exclusion. RAII guard returned by Mutex::lock().

When this guard goes out of scope, the mutex is automatically unlocked. Provides access to the protected data through Deref and DerefMut.

§Examples

use osal_rs::os::{Mutex, MutexFn};
 
let mutex = Mutex::new(0);
 
{
    let mut guard = mutex.lock().unwrap();
    *guard += 1;  // Access protected data
}  // Mutex automatically unlocked here

Trait Implementations§

Source§

impl<'a, T: ?Sized> Deref for MutexGuard<'a, T>

Provides immutable access to the protected data.

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<'a, T: ?Sized> DerefMut for MutexGuard<'a, T>

Provides mutable access to the protected data.

Source§

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.
Source§

impl<'a, T: ?Sized> Drop for MutexGuard<'a, T>

Automatically unlocks the mutex when the guard goes out of scope.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'a, T: ?Sized> MutexGuard<'a, T> for MutexGuard<'a, T>

Source§

fn update(&mut self, t: &T)
where T: Clone,

Updates the protected value with a new value.

§Note

This requires T to implement Clone to copy the value. Use the dereference operator directly for types that implement Copy.

§Examples
let mut guard = mutex.lock().unwrap();
let new_value = 42;
guard.update(&new_value);

Auto Trait Implementations§

§

impl<'a, T> Freeze for MutexGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> !RefUnwindSafe for MutexGuard<'a, T>

§

impl<'a, T> Send for MutexGuard<'a, T>
where T: Send + ?Sized,

§

impl<'a, T> Sync for MutexGuard<'a, T>
where T: Send + Sync + ?Sized,

§

impl<'a, T> Unpin for MutexGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> UnsafeUnpin for MutexGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> !UnwindSafe for MutexGuard<'a, T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.