Struct flexible_locks::RawOsMutex

pub struct RawOsMutex<T: UnsafeRawOsMutex> { /* fields omitted */ }

Platform mutex primitives for use with [Mutex] and [MutexWrap].

While the std::sync::Mutex type only uses one kind of platform mutex primitive (except on Windows, where things are a little convoluted), flexible-locks allow to use different kinds.

The available primitives are:

• pthread_mutex_t, on Unix-like systems, including macOS,
• OSSpinLock on macOS,
• SRWLock on Windows,
• CRITICAL_SECTION on Windows.

Other primitives could be added in the future, such as os_unfair_lock_t on macOS.

For types that can be statically initialized, until const fn is stabilized, initializer macros are provided:

• pthread_mutex_new
• osspinlock_new
• srwlock_new

For non-static initialization, Default::default() can be used for these.

For more specific non default use cases, you may want to implement your own type and implement the [RawMutex] or [UnsafeRawOsMutex] trait for it.

Safety

Generally speaking, platform mutex primitives cannot be moved in memory. That is, they must stay at the same address. Please ensure that is the case when you use them.

Trait Implementations

impl<T: UnsafeRawOsMutex> Send for RawOsMutex<T>

impl<T: UnsafeRawOsMutex> Sync for RawOsMutex<T>

impl<T: UnsafeRawOsMutex> RawMutex for RawOsMutex<T>

unsafe fn init(&mut self)

Initialize the raw mutex.

unsafe fn lock(&self)

Acquire the raw mutex.

unsafe fn unlock(&self)

Release the raw mutex.

unsafe fn destroy(&self)

Destroy the raw mutex.