EventStream<T> class

Implements a Stream for events and additional features.

See Stream for more documentation of delegated methods.

Implemented types
Implementers
Available Extensions

Constructors

EventStream()

Properties

eventValidator ↔ EventValidatorFunction<T>?
getter/setter pair
first → Future<T>
The first element of this stream.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
isBroadcast → bool
Whether this stream is a broadcast stream.
no setteroverride
isClosed → bool
Returns true if this stream is closed.
no setter
isEmpty → Future<bool>
Whether this stream contains any elements.
no setteroverride
isPaused → bool
Returns true if this stream is paused.
no setter
isUsed → bool
no setter
last → Future<T>
The last element of this stream.
no setteroverride
length → Future<int>
The number of elements in this stream.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Future<T>
The single element of this stream.
no setteroverride

Methods

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

Operators

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