ChannelIterator: add an example #4539
Open
Conversation
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
…he channel, with their own iterator instance
dkhalanskyjb
requested changes
Oct 9, 2025
| * Iterator for a [ReceiveChannel]. | ||
| * Instances of this interface are *not thread-safe* and shall not be used from concurrent coroutines. | ||
| * Instances of this interface are *not thread-safe*. | ||
| * Each iterator instance should be used by a single coroutine. |
There was a problem hiding this comment.
That's not true, it can be passed around different coroutines as long as this doesn't result in multithreaded access.
| * Instances of this interface are *not thread-safe*. | ||
| * Each iterator instance should be created and used by a single coroutine. | ||
| * | ||
| * An example usage: |
There was a problem hiding this comment.
Could you describe the sequence of events where this sample would answer a question a user may realistically have? It neither explains the next()/hasNext() interplay useful in deeply technical cases where you'd manipulate ChannelIterator manually, nor does it spell out "hey, this is not the class that you need to use manually, just write for (... in ...) instead" if that was the intention.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add an example, stress that different coroutines can iterate over the channel, with their own iterator instance