Skip to main content

Mutex

Struct Mutex 

Source
pub struct Mutex { /* private fields */ }
Expand description

A mutual exclusion primitive useful for protecting shared data.

This mutex will block tasks waiting for the lock to become available.

Implementations§

Source§

impl Mutex

Source

pub fn new(name: &str) -> Result<Self>

Creates a new OSAL mutex in the unlocked (available) state.

§Arguments
  • name: A unique string to identify the mutex.
Source

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

Acquires a mutex, blocking the current task until it is able to do so.

This function returns a MutexGuard when the lock has been acquired. The guard ensures that the lock is automatically released when it goes out of scope.

Source

pub fn get_id_by_name(name: &str) -> Result<OsalId>

Finds an existing mutex ID by its name.

Source

pub fn get_info(&self) -> Result<MutexProp>

Retrieves information about this mutex.

Trait Implementations§

Source§

impl Debug for Mutex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Mutex

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Mutex

§

impl RefUnwindSafe for Mutex

§

impl Send for Mutex

§

impl Sync for Mutex

§

impl Unpin for Mutex

§

impl UnsafeUnpin for Mutex

§

impl UnwindSafe for Mutex

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<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.