Add guarantee about when a spawned task may be polled #5816
Conversation
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
Diggsey
force-pushed
the
db-spawn-guarantee
branch
from
a944326
to
279a62b
Compare
Darksonn
reviewed
Jun 26, 2023
tokio/src/task/spawn.rs
Outdated
Comment on lines
18
to
19
| /// If the task is executed on the current thread it will not begin executing | ||
| /// until the current task yields to the executor. In other words, `spawn` |
There was a problem hiding this comment.
This could be interpreted as "but the multi-threaded runtime might do that!".
There was a problem hiding this comment.
Happy to reword it if you have an alternate suggestion.
There was a problem hiding this comment.
How about:
It is guaranteed that
spawnwill not synchronously poll the task being spawned. This means that callingspawnwhile holding a lock does not pose a risk of deadlocking with the spawned task.
Diggsey
force-pushed
the
db-spawn-guarantee
branch
from
279a62b
to
19a1124
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
This guarantee is widely relied upon for correctness, but is not explicitly mentioned in the documentation.
Solution
No code changes.