SetSignal<E> class

SetSignal makes easier interacting with sets in a reactive context.

final set = SetSignal({1});

Effect((_) {
  print(set.first);
}); // prints 1

set[0] = 100; // the effect prints 100

Inheritance

Object
ReadableSignal<Set<E>>
Signal<Set<E>>
SetSignal

Mixed-in types

SetMixin<E>

Available extensions

Constructors

SetSignal(Iterable<E> initialValue, {String? name, bool? equals, bool? autoDispose, bool? trackInDevTools, ValueComparator<Set<E>?> comparator = identical, bool? trackPreviousValue}): SetSignal makes easier interacting with sets in a reactive context.

Properties

autoDispose → bool: Whether to automatically dispose the signal (defaults to SolidartConfig.autoDispose).
finalinherited
comparator → ValueComparator<Set<E>?>: An optional comparator function, defaults to identical.
finalinherited
disposed → bool: Tells if the signal is disposed;
no setterinherited
equals → bool: Whether to check the equality of the value with the == equality.
finalinherited
first → E: The first element.
no setteroverride
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
hashCode → int: The hash code for this object.
no setterinherited
hasPreviousValue → bool: Indicates if there is a previous value. It is especially helpful if T is nullable.
no setterinherited
hasValue → bool: Whether or not the signal has been initialized with a value.
no setterinherited
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
isEmpty → bool: Whether this collection has no elements.
no setterinherited
isNotEmpty → bool: Whether this collection has at least one element.
no setterinherited
iterator → Iterator<E>: An iterator that iterates over the elements of this set.
no setteroverride
last → E: The last element.
no setteroverride
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: Returns the number of elements in the iterable.
no setteroverride
listenerCount → int: Returns the number of listeners listening to this signal.
no setterinherited
name → String: The name of the signal, useful for logging purposes.
finalinherited
nonNulls → Iterable<T>: Available on Iterable<T?>, provided by the NullableIterableExtensions extension
The non-null elements of this iterable.
no setter
previousValue → Set<E>?: The previous value, if any.
no setterinherited
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 setteroverride
singleOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The single element of this iterator, or null.
no setter
trackInDevTools → bool: finalinherited
trackPreviousValue → bool: finalinherited
untrackedPreviousValue → Set<E>?: Returns the untracked previous value of the signal.
no setterinherited
untrackedValue → Set<E>: Returns the value without triggering the reactive system.
no setterinherited
value ↔ Set<E>: The current signal value
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) → bool: Adds value to the set.
override
addAll(Iterable<E> elements) → void: Adds all elements to this set.
inherited
any(bool test(E element)) → bool: Checks whether any element of this iterable satisfies test.
inherited
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.
byName(String name) → T: Available on Iterable<T>, provided by the EnumByName extension
Finds the enum value in this list with name name.
call() → Set<E>: The current signal value
inherited
cast<R>() → Set<R>: Provides a view of this set as a set of R instances.
override
clear() → void: Removes all elements from the set.
override
contains(Object? element) → bool: Whether value is in the set.
override
containsAll(Iterable<Object?> other) → bool: Whether this set contains all the elements of other.
inherited
difference(Set<Object?> other) → Set<E>: Creates a new set with the elements of this that are not in other.
inherited
dispose() → void: Diposes 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 f(E element)) → bool: Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> f(E element)) → Iterable<T>: Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(E value), {E orElse()?}) → E: The first element that satisfies the given predicate test.
override
fold<T>(T initialValue, T combine(T previousValue, E element)) → T: Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<E> other) → Iterable<E>: Creates the lazy concatenation of this iterable and other.
inherited
forEach(void f(E element)) → void: Invokes action on each element of this iterable in iteration order.
inherited
intersection(Set<Object?> other) → Set<E>: Creates a new set which is the intersection between this set and other.
inherited
join([String separator = ""]) → String: Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(E value), {E orElse()?}) → E: The last element that satisfies the given predicate test.
override
lookup(Object? object) → E?: If an object equal to object is in the set, return it.
override
map<T>(T f(E element)) → Iterable<T>: 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(VoidCallback cb) → void: Fired when the signal is disposing
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.
inherited
remove(Object? value) → bool: Removes value from the set.
override
removeAll(Iterable<Object?> elements) → void: Removes each element of elements from this set.
override
removeWhere(bool test(E element)) → void: Removes all elements of this set that satisfy test.
override
retainAll(Iterable<Object?> elements) → void: Removes all elements of this set that are not elements in elements.
override
retainWhere(bool test(E element)) → void: Removes all elements of this set that fail to satisfy test.
override
setValue(Set<E> newValue) → Set<E>: Sets the current signal value with newValue.
override
shouldUpdate() → bool: Indicates if the signal should update its value.
inherited
singleWhere(bool test(E value), {E orElse()?}) → E: The single element that satisfies test.
override
skip(int n) → Iterable<E>: Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(E value)) → Iterable<E>: Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int n) → Iterable<E>: Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(E value)) → Iterable<E>: Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<E>: Creates a List containing the elements of this Iterable.
override
toReadSignal() → ReadableSignal<Set<E>>: Converts this Signal into a ReadableSignal Use this method to remove the visility to the value setter.
inherited
toSet() → Set<E>: Creates a Set with the same elements and behavior as this Set.
override
toString() → String: A string representation of this object.
override
union(Set<E> other) → Set<E>: Creates a new set which contains all the elements of this set and other.
inherited
until(bool condition(Set<E> value), {Duration? timeout}) → FutureOr<Set<E>>: Returns the future that completes when the condition evalutes to true. If the condition is already true, it completes immediately.
inherited
updateValue(Set<E> callback(Set<E> value)) → Set<E>: Calls a function with the current value and assigns the result as the new value.
override
where(bool f(E element)) → Iterable<E>: Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<T>: Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

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

SetSignal<E> class

Constructors

Properties

Methods

Operators

solidart library