nstd_timed_mutex_try_lock

Function nstd_timed_mutex_try_lock 

Source
pub unsafe extern "C" fn nstd_timed_mutex_try_lock<'m, 'a>(
    mutex: &'m NSTDTimedMutex<'a>,
) -> NSTDOptionalTimedMutexLockResult<'m, 'a>
Available on crate feature timed_mutex only.
Expand description

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

Attempting to call this function on a thread that already owns the lock will result in undefined behavior.

§Parameters:

  • const NSTDTimedMutex *mutex - The mutex to lock.

§Returns

NSTDOptionalTimedMutexLockResult guard - A handle to the mutex’s protected data.

§Safety

The mutex lock must not already be owned by the calling thread.