W3cubDocs

/Dart 2

StreamConsumer<S> class

Abstract interface for a "sink" accepting multiple entire streams.

A consumer can accept a number of consecutive streams using addStream, and when no further data need to be added, the close method tells the consumer to complete its work and shut down.

The Stream.pipe accepts a StreamConsumer and will pass the stream to the consumer's addStream method. When that completes, it will call close and then complete its own returned future.

Implementers

Constructors

StreamConsumer()

Properties

hashCodeint
read-only, inherited
The hash code for this object. [...]
runtimeTypeType
read-only, inherited
A representation of the runtime type of the object.

Methods

addStream(Stream<S> stream) → Future
Consumes the elements of stream. [...]
close() → Future
Tells the consumer that no further streams will be added. [...]
noSuchMethod(Invocation invocation) → dynamic
inherited
Invoked when a non-existent method or property is accessed. [...]
toString() → String
inherited
Returns a string representation of this object.

Operators

operator ==(dynamic 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.5.0/dart-async/StreamConsumer-class.html