-
Notifications
You must be signed in to change notification settings - Fork 655
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
Make NIOLoopBoundBox
off-EL with sending
#3091
Open
natikgadzhi
wants to merge
3
commits into
apple:main
Choose a base branch
from
natikgadzhi:ng/nioloopbox/make-box-with-sending
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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 |
---|---|---|
|
@@ -17,7 +17,7 @@ | |
/// | ||
/// ``NIOLoopBound`` is useful to transport a value of a non-`Sendable` type that needs to go from one place in | ||
/// your code to another where you (but not the compiler) know is on one and the same ``EventLoop``. Usually this | ||
/// involves `@Sendable` closures. This type is safe because it verifies (using ``EventLoop/preconditionInEventLoop(file:line:)-2fxvb``) | ||
/// involves `@Sendable` or `sending` closures. This type is safe because it verifies (using ``EventLoop/preconditionInEventLoop(file:line:)-2fxvb``) | ||
/// that this is actually true. | ||
/// | ||
/// A ``NIOLoopBound`` can only be constructed, read from or written to when you are provably | ||
|
@@ -59,7 +59,7 @@ public struct NIOLoopBound<Value>: @unchecked Sendable { | |
/// | ||
/// ``NIOLoopBoundBox`` is useful to transport a value of a non-`Sendable` type that needs to go from one place in | ||
/// your code to another where you (but not the compiler) know is on one and the same ``EventLoop``. Usually this | ||
/// involves `@Sendable` closures. This type is safe because it verifies (using ``EventLoop/preconditionInEventLoop(file:line:)-7ukrq``) | ||
/// involves `@Sendable` or `sending` closures. This type is safe because it verifies (using ``EventLoop/preconditionInEventLoop(file:line:)-7ukrq``) | ||
/// that this is actually true. | ||
/// | ||
/// A ``NIOLoopBoundBox`` can only be read from or written to when you are provably | ||
|
@@ -142,3 +142,26 @@ public final class NIOLoopBoundBox<Value>: @unchecked Sendable { | |
} | ||
} | ||
} | ||
|
||
#if compiler(>=6.0) // `sending` is >= 6.0 | ||
extension NIOLoopBoundBox { | ||
/// Initialise a ``NIOLoopBoundBox`` by `sending` (i.e. transferring) a value, validly callable off `eventLoop`. | ||
/// | ||
/// Contrary to ``init(_:eventLoop:)``, this method can be called off `eventLoop` because we are `sending` the value across the isolation domain. | ||
/// Because we're `sending` `value`, we just need to protect it against mutations (because nothing else can have access to it anymore). | ||
public static func makeBoxSendingValue( | ||
_ value: sending Value, | ||
as: Value.Type = Value.self, | ||
eventLoop: EventLoop | ||
) -> NIOLoopBoundBox<Value> { | ||
// Here, we -- possibly surprisingly -- do not precondition being on the EventLoop. This is okay for a few | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The comment is a copy-pasta from the other off-EL initializers, but I think it's fair to keep this for consistency. |
||
// reasons: | ||
// - This function only works by `sending` the value, so we don't need to worry about somebody | ||
// still holding a reference to this — Swift 6 will ensure the value is not modified erroneously. | ||
// - Because of Swift's Definitive Initialisation (DI), we know that we did write `self._value` before `init` | ||
// returns. | ||
// - The only way to ever write (or read indeed) `self._value` is by proving to be inside the `EventLoop`. | ||
.init(_value: value, uncheckedEventLoop: eventLoop) | ||
} | ||
} | ||
#endif |
This file contains 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.
Unrelated, but thought this would be more precise.
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.
Related: should I add more explicit documentation outlining that there are a bunch of functions to make a
NIOLoopBoundBox
off the event loop calledmake*
, and outline the use cases for them at a high level? Separate PR?