Skip to content

Adjust the docs for Mutex.withLockIfAvailable() re: spurious failures. #85497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adjust the docs for Mutex.withLockIfAvailable() re: spurious failures. #85497

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions stdlib/public/Synchronization/Mutex/Mutex.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,13 @@ extension Mutex where Value: ~Copyable {
/// as it will only be executed if the calling thread acquires
/// the lock.
///
/// - Returns: The return value, if any, of the `body` closure parameter
/// or nil if the lock couldn't be acquired.
/// - Returns: The return value, if any, of the `body` closure parameter or
/// `nil` if the lock couldn’t be acquired.
///
/// - Note: This function cannot spuriously fail to acquire the lock. The
/// behavior of similar functions in other languages (such as C's
/// `mtx_trylock()`) is platform-dependent and may differ from Swift's
/// behavior.
@available(SwiftStdlib 6.0, *)
@_alwaysEmitIntoClient
@_transparent
Expand Down