ValueStream<T> class abstract

An Stream that provides synchronous access to the last emitted item

Implemented types
Available extensions

Constructors

ValueStream.new()

Properties

error → Object
Returns last emitted error, failing if there is no error.
no setter
errorOrNull → Object?
Last emitted error, or null if no error added.
no setter
first → Future<T>
The first element of this stream.
no setterinherited
hasError → bool
Returns true when error is available.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasValue → bool
Returns true when value is available.
no setter
isBroadcast → bool
Whether this stream is a broadcast stream.
no setterinherited
isEmpty → Future<bool>
Whether this stream contains any elements.
no setterinherited
last → Future<T>
The last element of this stream.
no setterinherited
length → Future<int>
The number of elements in this stream.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Future<T>
The single element of this stream.
no setterinherited
stackTrace → StackTrace?
Returns StackTrace of the last emitted error, or null if no error added or the added error has no StackTrace.
no setter
value → T
Returns the last emitted value, failing if there is no value. See hasValue to determine whether value has already been set.
no setter
valueOrNull → T?
Returns either value, or null, should value not yet have been set.
no setter

Methods

any(bool test(T element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
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.
inherited
asyncExpand<E>(Stream<E>? convert(T event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
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.
inherited
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
inherited
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
inherited
debounce(Stream window(T event)) → Stream<T>

Available on Stream<T>, provided by the DebounceExtensions extension

Transforms a Stream so that will only emit items from the source sequence if a window has completed, without the source sequence emitting another item.
debounceTime(Duration duration) → Stream<T>

Available on Stream<T>, provided by the DebounceExtensions extension

Transforms a Stream so that will only emit items from the source sequence whenever the time span defined by duration passes, without the source sequence emitting another item.
distinct([bool equals(T previous, T next)?]) → Stream<T>
Skips data events if they are equal to the previous data event.
inherited
distinctBy<S>([S field(T event)?]) → Stream<T>

Available on Stream<T>, provided by the DistinctByX extension

use for FlowR.stream or flowr/FrViewModel.stream
distinctBy<S>([S field(T event)?]) → ValueStream<T>

Available on ValueStream<T>, provided by the DistinctByValueX extension

distinctBy for ValueStream
distinctWith<S>(S field(T event)) → Stream<S>

Available on Stream<T>, provided by the DistinctWithX extension

use for FlowR.stream or flowr.FrViewModel.stream
distinctWith<S>(S field(T event)) → ValueStream<S>

Available on ValueStream<T>, provided by the DistinctWithValueX extension

distinctBy for ValueStream
doOnCancel(FutureOr<void> onCancel()) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream subscription is cancelled. Often called doOnUnsubscribe or doOnDispose in other implementations.
doOnData(void onData(T event)) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream emits an item. In other implementations, this is called doOnNext.
doOnDone(void onDone()) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream finishes emitting items. In other implementations, this is called doOnComplete(d).
doOnEach(void onEach(Notification<T> notification)) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream emits data, emits an error, or emits done. The callback receives a Notification object.
doOnError(void onError(Object, StackTrace)) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream emits an error.
doOnListen(void onListen()) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream is first listened to.
doOnPause(void onPause()) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream subscription is paused.
doOnResume(void onResume()) → Stream<T>

Available on Stream<T>, provided by the DoExtensions extension

Invokes the given callback function when the stream subscription resumes receiving items.
drain<E>([E? futureValue]) → Future<E>
Discards all data on this stream, but signals when it is done or an error occurred.
inherited
elementAt(int index) → Future<T>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(T element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(T element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(T element), {T orElse()?}) → Future<T>
Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(T element)) → Future<void>
Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<T>
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>
Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(T element), {T orElse()?}) → Future<T>
Finds the last element in this stream matching test.
inherited
listen(void onData(T event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<T>
Adds a subscription to this stream.
inherited
map<S>(S convert(T event)) → Stream<S>
Transforms each element of this stream into a new stream event.
inherited
mapValue<U>(U mapper(T value)) → ValueStream<U>

Available on ValueStream<T>, provided by the MapValueX extension

map for ValueStream
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.
inherited
publish() → PublishConnectableStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a ConnectableStream that can be listened to multiple times. It will not begin emitting items from the original Stream until the connect method is invoked.
publishReplay({int? maxSize}) → ReplayConnectableStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a ReplayConnectableStream that can be listened to multiple times. It will not begin emitting items from the original Stream until the connect method is invoked.
publishValue() → ValueConnectableStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a ValueConnectableStream that can be listened to multiple times. It will not begin emitting items from the original Stream until the connect method is invoked.
publishValueSeeded(T seedValue) → ValueConnectableStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a ValueConnectableStream that can be listened to multiple times, providing an initial seeded value. It will not begin emitting items from the original Stream until the connect method is invoked.
reduce(T combine(T previous, T element)) → Future<T>
Combines a sequence of values by repeatedly applying combine.
inherited
share() → Stream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a new Stream that can be listened to multiple times. It will automatically begin emitting items when first listened to, and shut down when no listeners remain.
shareReplay({int? maxSize}) → ReplayStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a new ReplayStream that can be listened to multiple times. It will automatically begin emitting items when first listened to, and shut down when no listeners remain.
shareValue() → ValueStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a new ValueStream that can be listened to multiple times. It will automatically begin emitting items when first listened to, and shut down when no listeners remain.
shareValueSeeded(T seedValue) → ValueStream<T>

Available on Stream<T>, provided by the ConnectableStreamExtensions extension

Convert the current Stream into a new ValueStream that can be listened to multiple times, providing an initial value. It will automatically begin emitting items when first listened to, and shut down when no listeners remain.
singleWhere(bool test(T element), {T orElse()?}) → Future<T>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<T>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(T element)) → Stream<T>
Skip data events from this stream while they are matched by test.
inherited
switchMap<S>(Stream<S> mapper(T value)) → Stream<S>

Available on Stream<T>, provided by the SwitchMapExtension extension

Converts each emitted item into a Stream using the given mapper function. The newly created Stream will be be listened to and begin emitting items, and any previously created Stream will stop emitting.
take(int count) → Stream<T>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(T element)) → Stream<T>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<T> sink)?}) → Stream<T>
Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<T>>
Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<T>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<T, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
where(bool test(T event)) → Stream<T>
Creates a new stream from this stream that discards some elements.
inherited
whereNotNull() → Stream<T>

Available on Stream<T?>, provided by the WhereNotNullExtension extension

Returns a Stream which emits all the non-null elements of this Stream, in their original emission order.

Operators

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