IOSink abstract class

A combined byte and text output.

An IOSink combines a StreamSink of bytes with a StringSink, and allows easy output of both bytes and text.

Writing text (write) and adding bytes (add) may be interleaved freely.

While a stream is being added using addStream, any further attempts to add or write to the IOSink will fail until the addStream completes.

It is an error to add data to the IOSink after the sink is closed.

Implements

Implemented by

Constructors

IOSink(StreamConsumer<List<int>> target, { Encoding encoding: UTF8 }) factory: Create an IOSink that outputs to a target StreamConsumer of bytes.

done → Future read-only: Get a future that will complete when the consumer closes, or when an error occurs. This future is identical to the future returned by close.
encoding → Encoding read / write: The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.
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.

add(List<int> data) → void: Adds byte data to the target consumer, ignoring encoding.
addError(error, [ StackTrace stackTrace ]) → void: Passes the error to the target consumer as an error event.
addStream(Stream<List<int>> stream) → Future: Adds all elements of the given stream to this.
close() → Future: Close the target consumer.
flush() → Future: Returns a Future that completes once all buffered data is accepted by the underlying StreamConsumer.
write(Object obj) → void: Converts obj to a String by invoking Object.toString and adds the encoding of the result to the target consumer.
writeAll(Iterable objects, [ String separator = "" ]) → void: Iterates over the given objects and writes them in sequence.
writeCharCode(int charCode) → void: Writes the character of charCode.
writeln([Object obj = "" ]) → void: Converts obj to a String by invoking Object.toString and writes the result to this, followed by a newline.
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.

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dartlang.org/stable/1.24.3/dart-io/IOSink-class.html