pekko/akka-docs/src/main/paradox/stream/reference/fromIterator.md

27 lines
775 B
Markdown
Raw Normal View History

# fromIterator
Stream the values from an `Iterator`, requesting the next value when there is demand.
## Signature
@@signature [BasicDirectives.scala]($akka$/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #fromIterator }
## Description
Stream the values from an `Iterator`, requesting the next value when there is demand. The iterator will be created anew
for each materialization, which is the reason the @scala[`method`] @java[`factory`] takes a @scala[`function`] @java[`Creator`] rather than an `Iterator` directly.
If the iterator perform blocking operations, make sure to run it on a separate dispatcher.
@@@div { .callout }
**emits** the next value returned from the iterator
**completes** when the iterator reaches its end
@@@
## Example