IterableSignal<E> class

A Signal that holds a Iterable.

Inheritance

Object
Signal<Iterable<E>>
IterableSignal

Implemented types

Iterable<E>

Mixed-in types

IterableSignalMixin<E, Iterable<E>>

Available extensions

Constructors

IterableSignal(Iterable<E> value, {String? debugLabel, bool autoDispose = false}): Creates a IterableSignal with the given value.

Properties

$ → Signal<Iterable<E>>: Available on Iterable<E>, provided by the SignalIterableExtensions extension
Return a signal from a Iterable value
no setter
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
finalinherited
disposed ↔ bool: Check if the effect is disposed
getter/setter pairinherited
equalityCheck ↔ bool Function(Iterable<E> a, Iterable<E> b): Optional method to check if to values are the same
getter/setter pairinherited
first ← E: Available on Signal<List<E>>, provided by the ListSignalExtension extension

no getter
first → E: The first element.
no setterinherited
first → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
firstOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The first element of this iterator, or null if the iterable is empty.
no setter
globalId → int: Global ID of the signal
finalinherited
hashCode → int: The hash code for this object.
no setteroverride
indexed → Iterable<(int, T)>: Available on Iterable<T>, provided by the IterableExtensions extension
Pairs of elements of the indices and elements of this iterable.
no setter
internalValue → Iterable<E>: no setterinherited
isEmpty → bool: Whether this collection has no elements.
no setterinherited
isEmpty → bool: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
isInitialized → bool: Check if a signal value is set (does not subscribe)
no setterinherited
isNotEmpty → bool: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
isNotEmpty → bool: Whether this collection has at least one element.
no setterinherited
iterator → Iterator<E>: A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
iterator → Iterator<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
last → E: The last element.
no setterinherited
last → E: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension

no setter
last → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
last ← E: Available on Signal<List<E>>, provided by the ListSignalExtension extension

no getter
lastOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The last element of this iterable, or null if the iterable is empty.
no setter
length ← int: Available on Signal<List<E>>, provided by the ListSignalExtension extension

no getter
length → int: The number of elements in this Iterable.
no setterinherited
length → int: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
nonNulls → Iterable<T>: Available on Iterable<T?>, provided by the NullableIterableExtensions extension
The non-null elements of this iterable.
no setter
reversed → Iterable<E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension

no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
single → E: Checks that this iterable has only one element, and returns that element.
no setterinherited
single → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

no setter
singleOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The single element of this iterator, or null.
no setter
value ↔ Iterable<E>: Compute the current value
getter/setter pairinherited
version ↔ int: Version numbers should always be >= 0, because the special value -1 is used by Nodes to signify potentially unused but recyclable nodes.
getter/setter pairinherited
wait → Future<List<T>>: Available on Iterable<Future<T>>, provided by the FutureIterable extension
Waits for futures in parallel.
no setter

Methods

add(E value) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
add(E value) → bool: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
addAll(Iterable<E> elements) → void: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
addAll(Iterable<E> iterable) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
afterCreate(Iterable<E> val) → void: Internal hook for after a signal is created
inherited
any(bool test(E element)) → bool: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
any(bool test(E element)) → bool: Checks whether any element of this iterable satisfies test.
inherited
asMap() → Map<int, E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
asNameMap() → Map<String, T>: Available on Iterable<T>, provided by the EnumByName extension
Creates a map from the names of enum values to the values.
beforeUpdate(Iterable<E> val) → void: Internal hook for after a signal is updated
inherited
byName(String name) → T: Available on Iterable<T>, provided by the EnumByName extension
Finds the enum value in this list with name name.
call() → Iterable<E>: Return the value when invoked
inherited
cast<R>() → Iterable<R>: A view of this iterable as an iterable of R instances.
inherited
cast<R>() → Iterable<R>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
cast<R>() → Set<R>: Available on ReadonlySignal<Set<E>>, provided by the ReadonlySetSignalExtension extension
cast<R>() → List<R>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
clear() → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
clear() → void: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
contains(Object? value) → bool: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
contains(Object? value) → bool: Whether the collection contains an element equal to element.
inherited
containsAll(Iterable<Object?> other) → bool: Available on ReadonlySignal<Set<E>>, provided by the ReadonlySetSignalExtension extension
difference(Set<Object?> other) → Set<E>: Available on ReadonlySignal<Set<E>>, provided by the ReadonlySetSignalExtension extension
dispose() → void: Dispose the signal
inherited
elementAt(int index) → E: Returns the indexth element.
inherited
elementAt(int index) → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
elementAtOrNull(int index) → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The element at position index of this iterable, or null.
every(bool test(E element)) → bool: Checks whether every element of this iterable satisfies test.
inherited
every(bool test(E element)) → bool: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
expand<R>(Iterable<R> toElements(E element)) → Iterable<R>: Expands each element of this Iterable into zero or more elements.
inherited
expand<R>(Iterable<R> toElements(E element)) → Iterable<R>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
expand<R>(Iterable<R> toElements(E element)) → Iterable<R>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
fillRange(int start, int end, [E? fillValue]) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
firstWhere(bool test(E element), {E orElse()?}) → E: The first element that satisfies the given predicate test.
inherited
firstWhere(bool test(E element), {E orElse()?}) → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
firstWhere(bool test(E element), {E orElse()?}) → E: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
fold<R>(R initialValue, R combine(R previousValue, E element)) → R: Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
fold<R>(R initialValue, R combine(R previousValue, E element)) → R: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
fold<R>(R initialValue, R combine(R previousValue, E element)) → R: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
followedBy(Iterable<E> other) → Iterable<E>: Creates the lazy concatenation of this iterable and other.
inherited
followedBy(Iterable<E> other) → Iterable<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
followedBy(Iterable<E> other) → Iterable<E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
forEach(void action(E element)) → void: Invokes action on each element of this iterable in iteration order.
inherited
forEach(void action(E element)) → void: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
get() → Iterable<E>: Helper method to get the current value
inherited
getRange(int start, int end) → Iterable<E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
indexOf(E element, [int start = 0]) → int: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
indexWhere(bool test(E element), [int start = 0]) → int: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
insert(int index, E element) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
insertAll(int index, Iterable<E> iterable) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
internalRefresh() → bool: inherited
intersection(Set<Object?> other) → Set<E>: Available on ReadonlySignal<Set<E>>, provided by the ReadonlySetSignalExtension extension
join([String separator = ""]) → String: Converts each element to a String and concatenates the strings.
inherited
join([String separator = ""]) → String: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
lastIndexOf(E element, [int? start]) → int: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
lastIndexWhere(bool test(E element), [int? start]) → int: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
lastWhere(bool test(E element), {E orElse()?}) → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
lastWhere(bool test(E element), {E orElse()?}) → E: The last element that satisfies the given predicate test.
inherited
lookup(Object? object) → E?: Available on ReadonlySignal<Set<E>>, provided by the ReadonlySetSignalExtension extension
map<R>(R toElement(E e)) → Iterable<R>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
map<R>(R toElement(E e)) → Iterable<R>: The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onDispose(void cleanup()) → void Function(): Add a cleanup function to be called when the signal is disposed
inherited
overrideWith(Iterable<E> val) → Signal<Iterable<E>>: Override the current signal with a new value as if it was created with it
inherited
peek() → Iterable<E>: 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
readonly() → ReadonlySignal<Iterable<E>>: Returns a readonly signal
inherited
reduce(E combine(E value, E element)) → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
reduce(E combine(E value, E element)) → E: Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(Object? value) → bool: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
remove(Object? value) → bool: Available on Signal<List<E>>, provided by the ListSignalExtension extension
removeAll(Iterable<Object?> elements) → void: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
removeAt(int index) → E: Available on Signal<List<E>>, provided by the ListSignalExtension extension
removeLast() → E: Available on Signal<List<E>>, provided by the ListSignalExtension extension
removeRange(int start, int end) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
removeWhere(bool test(E element)) → void: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
removeWhere(bool test(E element)) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
replaceRange(int start, int end, Iterable<E> replacements) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
retainAll(Iterable<Object?> elements) → void: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
retainWhere(bool test(E element)) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
retainWhere(bool test(E element)) → void: Available on Signal<Set<E>>, provided by the SetSignalExtension extension
set(Iterable<E> val, {bool force = false}) → bool: Set the current value by a method
inherited
setAll(int index, Iterable<E> iterable) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
shuffle([Random? random]) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
singleWhere(bool test(E element), {E orElse()?}) → E: The single element that satisfies test.
inherited
singleWhere(bool test(E element), {E orElse()?}) → E: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
skip(int count) → Iterable<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
skip(int count) → Iterable<E>: Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(E value)) → Iterable<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
skipWhile(bool test(E value)) → Iterable<E>: Creates an Iterable that skips leading elements while test is satisfied.
inherited
sort([int compare(E a, E b)?]) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension
sorted([int compare(E a, E b)?]) → List<E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
Return a new array that is sorted by the compare function
sublist(int start, [int? end]) → List<E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
subscribe(void fn(Iterable<E> value)) → void Function(): Subscribe to value changes with a dispose function
inherited
subscribeToNode(Node node) → void: inherited
take(int count) → Iterable<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
take(int count) → Iterable<E>: Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(E value)) → Iterable<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
takeWhile(bool test(E value)) → Iterable<E>: Creates a lazy iterable of the leading elements satisfying test.
inherited
toJson() → dynamic: Convert value to JSON
inherited
toList({bool growable = true}) → List<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
toList({bool growable = true}) → List<E>: Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
toSet() → Set<E>: Creates a Set containing the same elements as this iterable.
inherited
toSignal({String? debugLabel, bool autoDispose = false}) → IterableSignal<T>: Available on Iterable<T>, provided by the SignalIterableUtils extension
Convert an existing list to IterableSignal
toString() → String: A string representation of this object.
inherited
union(Set<E> other) → Set<E>: Available on ReadonlySignal<Set<E>>, provided by the ReadonlySetSignalExtension extension
unsubscribeFromNode(Node node) → void: inherited
where(bool test(E element)) → Iterable<E>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension
where(bool test(E element)) → Iterable<E>: Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<R>() → Iterable<R>: Creates a new lazy Iterable with all elements that have type T.
inherited
whereType<R>() → Iterable<R>: Available on ReadonlySignal<Iterable<E>>, provided by the ReadonlyIterableSignalExtension extension

Operators

operator +(List<E> other) → List<E>: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
operator ==(Object other) → bool: The equality operator.
override
operator [](int index) → E: Available on ReadonlySignal<List<E>>, provided by the ReadonlyListSignalExtension extension
operator []=(int index, E value) → void: Available on Signal<List<E>>, provided by the ListSignalExtension extension

IterableSignal<E> class

Constructors

Properties

Methods

Operators

signals library