StreamIterator<T> class
An Iterator-like interface for the values of a Stream.
This wraps a Stream and a subscription on the stream. It listens on the stream, and completes the future returned by moveNext when the next value becomes available.
The stream may be paused between calls to moveNext.
The current value must only be used after a future returned by moveNext has completed with true
, and only until moveNext is called again.
Constructors
- StreamIterator(Stream<
T> stream)factory - Create a StreamIterator on
stream
.
Properties
- current → T read-only
- The current value of the stream. [...]
- hashCode → int read-only, inherited
- The hash code for this object. [...]
- runtimeType → Type read-only, inherited
- A representation of the runtime type of the object.
Methods
- cancel(
) → Future - Cancels the stream iterator (and the underlying stream subscription) early. [...]
- moveNext(
) → Future< bool> - Wait for the next stream value to be available. [...]
- noSuchMethod(
Invocation invocation) → dynamic inherited - Invoked when a non-existent method or property is accessed. [...]
- toString(
) → String inherited - A string representation of this object. [...]
Operators
- operator ==(
Object other) → bool inherited - The equality operator. [...]
© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dart.dev/stable/2.13.0/dart-async/StreamIterator-class.html