task: clarify task ID reuse guarantees #7577
Merged
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.
Fixes: #7553
As discussed in the above issue, we have an implicit guarantee that a task ID is not reused until both the task finishes and its
JoinHandleis joined on or dropped. User code requires this guarantee to do useful things with the ID, so this PR updates docs to make it more explicit.I chose the wording "joined on" to cover cases outside of plain
.await. In particular, joining a task via&mut JoinHandle(e.g.tokio::select!) counts for all intents and purposes, despite not strictly consuming theJoinHandle.