IterableSignalMixin<E, T extends Iterable<E>> mixin

Mixin to upgrade an iterable signal with reactive properties

Superclass constraints

• Signal<T>

Implemented types

• Iterable<E>

Available extensions

• EnumByName
• FutureIterable
• IterableExtensions
• NullableIterableExtensions
• SignalIterableUtils

Properties

autoDispose ↔ bool

Throws and error if read after dispose and can be disposed on last unsubscribe.

getter/setter pair, inherited

brand → Symbol

final, inherited

debugLabel → String?

Debug label for Debug Mode

final, inherited

disposed ↔ bool

Check if the effect is disposed

getter/setter pair, inherited

equalityCheck ↔ bool Function(T a, T b)

Optional method to check if to values are the same

getter/setter pair, inherited

first → E

The first element.

no setter, override

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

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

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 ↔ T

getter/setter pair, inherited

isEmpty → bool

Whether this collection has no elements.

no setter, override

isInitialized ↔ bool

Check if a signal value is set (does not subscribe)

getter/setter pair, inherited

isNotEmpty → bool

Whether this collection has at least one element.

no setter, override

iterator → Iterator<E>

A new Iterator that allows iterating the elements of this Iterable.

no setter, override

last → E

The last element.

no setter, override

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

The number of elements in this Iterable.

no setter, override

node ↔ Node?

getter/setter pair, inherited

nonNulls → Iterable<T>

Available on Iterable<T?>, provided by the NullableIterableExtensions extension

The non-null elements of this iterable.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

single → E

Checks that this iterable has only one element, and returns that element.

no setter, override

singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The single element of this iterator, or null.

no setter

targets ↔ Node?

getter/setter pair, inherited

value ↔ T

Compute the current value

getter/setter pair, inherited

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 pair, inherited

wait → Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.

no setter

Methods

afterCreate(T val) → void

Internal hook for after a signal is created

inherited

any(bool test(E element)) → bool

Checks whether any element of this iterable satisfies test.

override

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(T 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() → T

Return the value when invoked

inherited

cast<R>() → Iterable<R>

A view of this iterable as an iterable of R instances.

override

contains(Object? value) → bool

Whether the collection contains an element equal to element.

override

dispose() → void

Dispose the signal

inherited

elementAt(int index) → E

Returns the indexth element.

override

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.

override

expand<R>(Iterable<R> toElements(E element)) → Iterable<R>

Expands each element of this Iterable into zero or more elements.

override

firstWhere(bool test(E element), {E orElse()?}) → E

The first element that satisfies the given predicate test.

override

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

override

followedBy(Iterable<E> other) → Iterable<E>

Creates the lazy concatenation of this iterable and other.

override

forEach(void action(E element)) → void

Invokes action on each element of this iterable in iteration order.

override

get() → T

Helper method to get the current value

inherited

internalRefresh() → bool

inherited

internalSetValue(T val) → void

inherited

join([String separator = ""]) → String

Converts each element to a String and concatenates the strings.

override

lastWhere(bool test(E element), {E orElse()?}) → E

The last element that satisfies the given predicate test.

override

map<R>(R toElement(E e)) → Iterable<R>

The current elements of this iterable modified by toElement.

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

overrideWith(T val) → Signal<T>

Override the current signal with a new value as if it was created with it

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

readonly() → ReadonlySignal<T>

Returns a readonly signal

inherited

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.

override

set(T val, {bool force = false}) → bool

Set the current value by a method

inherited

singleWhere(bool test(E element), {E orElse()?}) → E

The single element that satisfies test.

override

skip(int count) → Iterable<E>

Creates an Iterable that provides all but the first count elements.

override

skipWhile(bool test(E value)) → Iterable<E>

Creates an Iterable that skips leading elements while test is satisfied.

override

subscribe(void fn(T value)) → void Function()

Subscribe to value changes with a dispose function

inherited

subscribeToNode(Node node) → void

inherited

take(int count) → Iterable<E>

Creates a lazy iterable of the count first elements of this iterable.

override

takeWhile(bool test(E value)) → Iterable<E>

Creates a lazy iterable of the leading elements satisfying test.

override

toJson() → dynamic

Convert value to JSON

inherited

toList({bool growable = true}) → List<E>

Creates a List containing the elements of this Iterable.

override

toSet() → Set<E>

Creates a Set containing the same elements as this iterable.

override

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

unsubscribeFromNode(Node node) → void

inherited

where(bool test(E element)) → Iterable<E>

Creates a new lazy Iterable with all elements that satisfy the predicate test.

override

whereType<R>() → Iterable<R>

Creates a new lazy Iterable with all elements that have type T.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited