ChannelIterator: add an example #4539
Conversation
…he channel, with their own iterator instance
| * 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.
There was a problem hiding this comment.
I'm addressing my own confusion with the original wording - it primed me to think that only one coroutine is allowed to create instances of the iterator.
There was a problem hiding this comment.
Added wording on "don't use directly" and "next/hasNext"
Add an example, stress that different coroutines can iterate over the channel, with their own iterator instance