Stdin class

The standard input stream of the process.

Allows both synchronous and asynchronous reads from the standard input stream.

Mixing synchronous and asynchronous reads is undefined.

Inheritance

Object
Stream<List<int>>
Stdin

Implemented types

Stream<List<int>>

Properties

echoMode ↔ bool read / write: Whether echo mode is enabled on stdin.
echoNewlineMode ↔ bool read / write: Whether echo newline mode is enabled on stdin.
first → Future<List<int>> read-onlyinherited: The first element of this stream.
hashCode → int read-onlyinherited: The hash code for this object.
hasTerminal → bool read-only: Whether there is a terminal attached to stdin.
isBroadcast → bool read-onlyinherited: Whether this stream is a broadcast stream.
isEmpty → Future<bool> read-onlyinherited: Whether this stream contains any elements.
last → Future<List<int>> read-onlyinherited: The last element of this stream.
length → Future<int> read-onlyinherited: The number of elements in this stream.
lineMode ↔ bool read / write: Whether line mode is enabled on stdin.
runtimeType → Type read-onlyinherited: A representation of the runtime type of the object.
single → Future<List<int>> read-onlyinherited: The single element of this stream.
supportsAnsiEscapes → bool read-only: Whether connected to a terminal that supports ANSI escape sequences.

Methods

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

Operators

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

© 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.19.6/dart-io/Stdin-class.html