Module timed_mutex 

Available on crate feature timed_mutex only.

A mutual exclusion primitive with a timed locking mechanism.

Functions

nstd_timed_mutex_drop^⚠

Frees an instance of NSTDTimedMutex after invoking callback with the mutex’s data.

nstd_timed_mutex_free^⚠

Frees an instance of NSTDTimedMutex.

nstd_timed_mutex_get^⚠

Returns an immutable raw pointer to a timed mutex guard’s protected data.

nstd_timed_mutex_get_mut^⚠

Returns an raw pointer to a timed mutex guard’s protected data.

nstd_timed_mutex_into_inner^⚠

Consumes a timed mutex and returns the data it was protecting.

nstd_timed_mutex_is_poisoned^⚠

Determines whether or not a timed mutex’s data is poisoned.

nstd_timed_mutex_lock^⚠

Waits for a timed mutex lock to become acquired, returning a guard wrapping the protected data.

nstd_timed_mutex_new^⚠

Creates a new timed mutual exclusion primitive.

nstd_timed_mutex_timed_lock^⚠

The timed variant of nstd_timed_mutex_lock returning an uninitialized “none” result if the mutex lock could not be acquired after a specified number of seconds.

nstd_timed_mutex_try_lock^⚠

The non-blocking variant of nstd_timed_mutex_lock returning an uninitialized “none” result if the mutex is locked by another thread.

nstd_timed_mutex_unlock^⚠

Unlocks a timed mutex by consuming a mutex guard.

Type Aliases

NSTDOptionalTimedMutex

Represents an optional value of type NSTDTimedMutex.

NSTDOptionalTimedMutexLockResult

An optional value of type NSTDTimedMutexLockResult.

NSTDTimedMutex

A mutual exclusion primitive with a timed locking mechanism.

NSTDTimedMutexGuard

A handle to a timed mutex’s data.

NSTDTimedMutexLockResult

A result type containing a timed mutex lock whether or not the mutex is poisoned.