withLockIfAvailable(_:)

Declaration

borrowing func withLockIfAvailable<Result, E>(_ body: (inout sending Value) throws(E) -> sending  Result) throws(E) -> sending Result? where E : Error, Result : ~Copyable

Parameters

• body:

  A closure with a parameter of Value that has exclusive access to the value being stored within this mutex. This closure is considered the critical section as it will only be executed if the calling thread acquires the lock.

Return Value

The return value, if any, of the body closure parameter or nil if the lock couldn’t be acquired.

Discussion

If the calling thread was successful in acquiring the lock, the closure will be executed and then immediately after it will release ownership of the lock. If we were unable to acquire the lock, this will return nil.

This method is equivalent to the following sequence of code:

guard mutex.tryLock() else {
  return nil
}
defer {
  mutex.unlock()
}
return try body(&value)