SyncStream<T> class

The SyncStream is used to control (and potentially debounce) updates to a single value, that are then dispatched as a single stream of updates

Implemented types

• ValueStream<T?>

Mixed-in types

• Disposable

Available extensions

• ValueStreamExtensions
• ValueStreamFutureExtensions
• ValueStreamIterableExtensions
• ValueStreamIterableFutureExtensions
• ValueStreamIterableMapEntryExtensions
• ValueStreamOfMapExtensions

Constructors

SyncStream.controller({FutureOr<T>? initialValue, required String debugName, Consumer<T>? onChange})

This stream doesn't subscribe to an upstream branch for updates, but can still be updated.

SyncStream.empty()

SyncStream.fromStream(Stream<T> after, [T? current, Consumer<T>? onChange, String? debugName])

SyncStream.fromVStream(ValueStream<T> source, [Consumer<T>? onChange, String? debugName])

Properties

after → Stream<T?>

no setter, override

current ↔ T?

getter/setter pair

debugName → String?

final

future → Future<T?>

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

isFirstResolved → bool

no setter, override

isNotEmpty → bool

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

no setter

keys → ValueStream<Iterable<K>>

Available on ValueStream<Map<K, V>>, provided by the ValueStreamOfMapExtensions extension

no setter

length → int

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

no setter

log → Logger

final

loggerName → String?

no setter

onChange → Consumer<T>?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

values → ValueStream<Iterable<V>>

Available on ValueStream<Map<K, V>>, provided by the ValueStreamOfMapExtensions extension

no setter

Methods

awaitEach() → ValueStream<Future<Iterable<X>>>

Available on ValueStream<Iterable<Future<X>>>, provided by the ValueStreamIterableFutureExtensions extension

combined<R, O>(ValueStream<O> other, R combiner(T? self, O? other)) → ValueStream<R>

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

Combines another stream.

combinedUnresolved<R, O>(ValueStream<O> other, Resolvable<R?> combiner(FutureOr<T?> self, FutureOr<O?> other)) → ValueStream<R?>

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

Combines another stream, passing unresolved Futures

combineWith(Iterable<ValueStream<Iterable<X>>> others, [String? debugName]) → ValueStream<Iterable<X>>

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

debounced([Duration? duration]) → ValueStream<T>

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

dispose() → Future

disposeAll() → Future

inherited

expandEach<R>(Iterable<R> expander(X input)) → ValueStream<Iterable<R>>

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

filteredBy<R>(ValueStream<R> other, bool filter(X item, R? other)) → ValueStream<Iterable<X>>

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

Filters this stream using a result of another stream. This allows us to apply the filter when either the filtering source changes or the original list changes.

filterEntries(bool predicate(K key, V value)) → ValueStream<Map<K, V>>

Available on ValueStream<Map<K, V>>, provided by the ValueStreamOfMapExtensions extension

filterItems(bool predicate(X input)?) → ValueStream<Iterable<X>>

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

flatten([T? initialValue, bool filterNotNull = true]) → Stream<T?>

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

followedBy(ValueStream<Iterable<X>> other) → ValueStream<Iterable<X>>

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

forward(Stream<T> from) → void

Forwards a stream to this one

get() → FutureOr<T>?

override

listen(void onData(T item)) → StreamSubscription

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

map<R>(R mapper(T? input)) → ValueStream<R>

Basics of converting something over

override

mapEach<R>(R mapper(X input)) → ValueStream<Iterable<R>>

Available on ValueStream<Iterable<X>>, provided by the ValueStreamIterableExtensions extension

mapEntries<R>(MapEntry<K, R> mapper(K key, V value)) → ValueStream<Map<K, R>>

Available on ValueStream<Map<K, V>>, provided by the ValueStreamOfMapExtensions extension

mapValues<R>(R mapper(K key, V value)) → ValueStream<Map<K, R>>

Available on ValueStream<Map<K, V>>, provided by the ValueStreamOfMapExtensions extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

peek(void peek(T item)) → ValueStream<T>

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

registerDisposer(Disposer callback) → void

inherited

registerStream(Stream? stream) → void

inherited

registerSubscription(StreamSubscription? subscription) → void

inherited

removeDisposer(FutureOr dispose()) → void

inherited

reset() → void

resolve([T? ifAbsent]) → T?

override

sampled() → ValueStream<X?>

Available on ValueStream<Future<X>>, provided by the ValueStreamFutureExtensions extension

thenMap<R>(R mapper(X input)) → ValueStream<Future<R>>

Available on ValueStream<Future<X>>, provided by the ValueStreamFutureExtensions extension

thenMapEach<R>(R mapper(X input)) → ValueStream<Iterable<Future<R>>>

Available on ValueStream<Iterable<Future<X>>>, provided by the ValueStreamIterableFutureExtensions extension

toMap() → ValueStream<Map<K, V>>

Available on ValueStream<Iterable<MapEntry<K, V>>>, provided by the ValueStreamIterableMapEntryExtensions extension

toString() → String

A string representation of this object.

inherited

toSyncStream([void onChange(T value)?, String? name]) → SyncStream<T>

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

toVStream() → ValueStream<T?>

update(T? current) → void

Like StreamController.add

where(Predicate<T?> predicate) → ValueStream<T>

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

Filters the entire stream, including the current element

whereNotNull() → ValueStream<T>

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited