docs: add cancel-safety docs to StreamExt::next methods and types #4715
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
Many futures are commonly used in
select!
(or similar) constructs, and people are interested to know which futures are cancel-safe. Two such common features arenext
andtry_next
, to get new values from aStream
. These only hold onto references to the underlying stream, and are therefor cancel-safe.Solution
Document the cancel-safety of the
StreamExt::next
andStreamExt::try_next
methods (and their underlying future types)