-
Notifications
You must be signed in to change notification settings - Fork 24
Fix for Issue#129 and Issue#173 by fixing a threading issue with the original implementation. #186
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.
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| import Foundation | ||
|
|
||
| /// A generic wrapper for isolating a mutable value with a lock. | ||
| @dynamicMemberLookup | ||
| public final class LockIsolated<Value>: @unchecked Sendable { | ||
| private var _value: Value | ||
| private let lock = NSRecursiveLock() | ||
|
|
||
| /// Initializes lock-isolated state around a value. | ||
| /// | ||
| /// - Parameter value: A value to isolate with a lock. | ||
| public init(_ value: @autoclosure @Sendable () throws -> Value) rethrows { | ||
| self._value = try value() | ||
| } | ||
|
|
||
| public subscript<Subject: Sendable>(dynamicMember keyPath: KeyPath<Value, Subject>) -> Subject { | ||
| self.lock.sync { | ||
| self._value[keyPath: keyPath] | ||
| } | ||
| } | ||
|
|
||
| /// Perform an operation with isolated access to the underlying value. | ||
| /// | ||
| /// Useful for modifying a value in a single transaction. | ||
| /// | ||
| /// ```swift | ||
| /// // Isolate an integer for concurrent read/write access: | ||
| /// var count = LockIsolated(0) | ||
| /// | ||
| /// func increment() { | ||
| /// // Safely increment it: | ||
| /// self.count.withValue { $0 += 1 } | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// - Parameter operation: An operation to be performed on the the underlying value with a lock. | ||
| /// - Returns: The result of the operation. | ||
| public func withValue<T: Sendable>( | ||
| _ operation: @Sendable (inout Value) throws -> T | ||
| ) rethrows -> T { | ||
| try self.lock.sync { | ||
| var value = self._value | ||
| defer { self._value = value } | ||
| return try operation(&value) | ||
| } | ||
| } | ||
|
|
||
| /// Overwrite the isolated value with a new value. | ||
| /// | ||
| /// ```swift | ||
| /// // Isolate an integer for concurrent read/write access: | ||
| /// var count = LockIsolated(0) | ||
| /// | ||
| /// func reset() { | ||
| /// // Reset it: | ||
| /// self.count.setValue(0) | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// > Tip: Use ``withValue(_:)`` instead of ``setValue(_:)`` if the value being set is derived | ||
| /// > from the current value. That is, do this: | ||
| /// > | ||
| /// > ```swift | ||
| /// > self.count.withValue { $0 += 1 } | ||
| /// > ``` | ||
| /// > | ||
| /// > ...and not this: | ||
| /// > | ||
| /// > ```swift | ||
| /// > self.count.setValue(self.count + 1) | ||
| /// > ``` | ||
| /// > | ||
| /// > ``withValue(_:)`` isolates the entire transaction and avoids data races between reading and | ||
| /// > writing the value. | ||
| /// | ||
| /// - Parameter newValue: The value to replace the current isolated value with. | ||
| public func setValue(_ newValue: @autoclosure @Sendable () throws -> Value) rethrows { | ||
| try self.lock.sync { | ||
| self._value = try newValue() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension LockIsolated where Value: Sendable { | ||
| /// The lock-isolated value. | ||
| public var value: Value { | ||
| self.lock.sync { | ||
| self._value | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension NSRecursiveLock { | ||
| @inlinable @discardableResult | ||
| @_spi(Internals) public func sync<R>(work: () throws -> R) rethrows -> R { | ||
| self.lock() | ||
| defer { self.unlock() } | ||
| return try work() | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cmriboldi is there a particular reason why this class is public?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No it doesn't need to be public.