dart:async

StreamSink<S> class

A object that accepts stream events both synchronously and asynchronously.

A StreamSink combines the methods from StreamConsumer and EventSink.

The EventSink methods can't be used while the addStream is called. As soon as the addStream's Future completes with a value, the EventSink methods can be used again.

If addStream is called after any of the EventSink methods, it'll be delayed until the underlying system has consumed the data added by the EventSink methods.

When EventSink methods are used, the done Future can be used to catch any errors.

When close is called, it will return the done Future.

Implemented types

• EventSink<S>
• StreamConsumer<S>

Implementers

• IOSink
• StreamController
• WebSocket

Constructors

StreamSink()

Properties

done → Future

read-only

Return a future which is completed when the StreamSink is finished. [...]

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

close() → Future

override

Tells the stream sink that no further streams will be added. [...]

add(S event) → void

inherited

Adds a data event to the sink. [...]

addError(Object error, [ StackTrace stackTrace ]) → void

inherited

Adds an error to the sink. [...]

addStream(Stream<S> stream) → Future

inherited

Consumes the elements of stream. [...]

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. [...]