StreamSignalMixin<T> mixin

Stream implementation for AsyncState

Superclass constraints
Implemented types
Available extensions

Properties

autoDispose ↔ bool
Throws and error if read after dispose and can be disposed on last unsubscribe.
getter/setter pairinherited
debugLabel → String?
Debug label for Debug Mode
no setterinherited
disposed ↔ bool
Check if the effect is disposed
getter/setter pairinherited
first → Future<T>
The first element of this stream.
no setteroverride
globalId → int
Global ID of the signal
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isBroadcast → bool
Whether this stream is a broadcast stream.
no setteroverride
isEmpty → Future<bool>
Whether this stream contains any elements.
no setteroverride
isInitialized → bool
Check if a signal value is set (does not subscribe)
no setterinherited
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
untrackedValue → T

Available on ReadonlySignal<T>, provided by the ReadonlySignalUntrackedValueUtils extension

Runs a callback function that returns the signal value without subscribing to the signal updates.
no setter
value → T
Compute the current value
no setterinherited

Methods

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
call() → T
Return the value when invoked
inherited
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
override
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
override
dispose() → void
Dispose the signal
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 index) → 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<void>
Executes action on each element of this stream.
override
get() → T
Helper method to get the current value
inherited
handleError(Function onError, {bool test(dynamic 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}) → StreamSubscription<T>
Adds a subscription to this stream.
override
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
onDispose(void cleanup()) → EffectCleanup
Add a cleanup function to be called when the signal is disposed
inherited
peek() → T
In the rare instance that you have an effect that should write to another signal based on the previous value, but you don't want the effect to be subscribed to that signal, you can read a signals's previous value via signal.peek().
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
select<R>(R selector(ReadonlySignal<T>), {bool autoDispose = false, String? debugLabel}) → Computed<R>

Available on ReadonlySignal<T>, provided by the ReadonlySignalUtils extension

Select a value and return a computed signal to listen for changes
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
subscribe(void fn(T value)) → void Function()
Subscribe to value changes with a dispose function
inherited
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
toJson() → dynamic
Convert value to JSON
inherited
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
toStream() → Stream<T>

Available on ReadonlySignal<T>, provided by the ReadonlySignalUtils extension

Convert a signal to a Stream to be consumed as a read only stream.
toStreamSignal({bool? cancelOnError, String? debugLabel, T? initialValue, bool autoDispose = false, bool lazy = true, List<ReadonlySignal> dependencies = const [], void onDone()?}) → StreamSignal<T>

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

Convert a stream to a signal
toString() → String
A string representation of this object.
inherited
toSyncSignal(T initialData) → ReadonlySignal<T>

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

Convert a Stream to ReadonlySignal and provide initial value.
transform<S>(StreamTransformer<T, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
override
unwatch(BuildContext context) → void

Available on ReadonlySignal<T>, provided by the FlutterReadonlySignalUtils extension

Stop subscriptions to updates on a signal for watchers
watch(BuildContext context, {String? debugLabel}) → T

Available on ReadonlySignal<T>, provided by the FlutterReadonlySignalUtils extension

Rebuild the Element that the current signal is inside of
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