ZipStream<T, R> class

Merges the specified streams into one stream sequence using the given zipper Function whenever all of the stream sequences have produced an element at a corresponding index.

It applies this function in strict sequence, so the first item emitted by the new Stream will be the result of the function applied to the first item emitted by Stream #1 and the first item emitted by Stream #2; the second item emitted by the new ZipStream will be the result of the function applied to the second item emitted by Stream #1 and the second item emitted by Stream #2; and so forth. It will only emit as many items as the number of items emitted by the source Stream that emits the fewest items.

If the provided streams is empty, the resulting sequence completes immediately without emitting any items and without any calls to the zipper function.

Interactive marble diagram

Basic Example

ZipStream(
  [
    Stream.fromIterable(['A']),
    Stream.fromIterable(['B']),
    Stream.fromIterable(['C', 'D']),
  ],
  (values) => values.join(),
).listen(print); // prints 'ABC'

Example with a specific number of Streams

If you wish to zip a specific number of Streams together with proper types information for the value of each Stream, use the zip2 - zip9 operators.

ZipStream.zip2(
  Stream.fromIterable(['A']),
  Stream.fromIterable(['B', 'C']),
  (a, b) => a + b,
)
.listen(print); // prints 'AB'

Inheritance

Object
Stream<R>
StreamView<R>
ZipStream

Available extensions

Constructors

ZipStream(Iterable<Stream<T>> streams, R zipper(List<T> values)): Constructs a Stream which merges the specified streams into a sequence using the given zipper Function, whenever all of the streams have produced an element at a corresponding index.

Properties

first → Future<R>: The first element of this stream.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
isBroadcast → bool: Whether this stream is a broadcast stream.
no setterinherited
isEmpty → Future<bool>: Whether this stream contains any elements.
no setterinherited
last → Future<R>: The last element of this stream.
no setterinherited
length → Future<int>: The number of elements in this stream.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
single → Future<R>: The single element of this stream.
no setterinherited

Methods

any(bool test(R element)) → Future<bool>: Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<R> subscription)?, void onCancel(StreamSubscription<R> subscription)?}) → Stream<R>: Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(R event)) → Stream<E>: Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(R event)) → Stream<E>: Creates a new stream with each data event of this stream asynchronously mapped to a new event.
inherited
cast<R>() → Stream<R>: Adapt this stream to be a Stream<R>.
inherited
contains(Object? needle) → Future<bool>: Returns whether needle occurs in the elements provided by this stream.
inherited
distinct([bool equals(R previous, R next)?]) → Stream<R>: Skips data events if they are equal to the previous data event.
inherited
drain<E>([E? futureValue]) → Future<E>: Discards all data on this stream, but signals when it is done or an error occurred.
inherited
elementAt(int index) → Future<R>: Returns the value of the indexth data event of this stream.
inherited
every(bool test(R element)) → Future<bool>: Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(R element)) → Stream<S>: Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(R element), {R orElse()?}) → Future<R>: Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, R element)) → Future<S>: Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(R element)) → Future<void>: Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<R>: Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>: Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(R element), {R orElse()?}) → Future<R>: Finds the last element in this stream matching test.
inherited
listen(void onData(R value)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<R>: Adds a subscription to this stream.
inherited
map<S>(S convert(R event)) → Stream<S>: Transforms each element of this stream into a new stream event.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
pipe(StreamConsumer<R> streamConsumer) → Future: Pipes the events of this stream into streamConsumer.
inherited
reduce(R combine(R previous, R element)) → Future<R>: Combines a sequence of values by repeatedly applying combine.
inherited
singleWhere(bool test(R element), {R orElse()?}) → Future<R>: Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<R>: Skips the first count data events from this stream.
inherited
skipWhile(bool test(R element)) → Stream<R>: Skip data events from this stream while they are matched by test.
inherited
take(int count) → Stream<R>: Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(R element)) → Stream<R>: Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<R> sink)?}) → Stream<R>: Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<R>>: Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<R>>: Collects the data of this stream in a Set.
inherited
toString() → String: A string representation of this object.
inherited
transform<S>(StreamTransformer<R, S> streamTransformer) → Stream<S>: Applies streamTransformer to this stream.
inherited
where(bool test(R event)) → Stream<R>: Creates a new stream from this stream that discards some elements.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

list<T>(Iterable<Stream<T>> streams) → ZipStream<T, List<T>>: Constructs a Stream which merges the specified streams into a List, containing values that were produced by the streams at a corresponding index.
zip2<A, B, R>(Stream<A> streamOne, Stream streamTwo, R zipper(A a, B b)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip3<A, B, C, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, R zipper(A a, B b, C c)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip4<A, B, C, D, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, Stream<D> streamD, R zipper(A a, B b, C c, D d)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip5<A, B, C, D, E, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, Stream<D> streamD, Stream<E> streamE, R zipper(A a, B b, C c, D d, E e)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip6<A, B, C, D, E, F, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, Stream<D> streamD, Stream<E> streamE, Stream<F> streamF, R zipper(A a, B b, C c, D d, E e, F f)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip7<A, B, C, D, E, F, G, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, Stream<D> streamD, Stream<E> streamE, Stream<F> streamF, Stream<G> streamG, R zipper(A a, B b, C c, D d, E e, F f, G g)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip8<A, B, C, D, E, F, G, H, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, Stream<D> streamD, Stream<E> streamE, Stream<F> streamF, Stream<G> streamG, Stream<H> streamH, R zipper(A a, B b, C c, D d, E e, F f, G g, H h)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.
zip9<A, B, C, D, E, F, G, H, I, R>(Stream<A> streamA, Stream streamB, Stream<C> streamC, Stream<D> streamD, Stream<E> streamE, Stream<F> streamF, Stream<G> streamG, Stream<H> streamH, Stream streamI, R zipper(A a, B b, C c, D d, E e, F f, G g, H h, I i)) → ZipStream<dynamic, R>: Constructs a Stream which merges the specified Streams into a sequence using the given zipper Function, whenever all of the provided Streams have produced an element at a corresponding index.