SetSignal<E> class

A Signal that holds a Set.

Inheritance
Implemented types
Available extensions

Constructors

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

Properties

autoDispose → bool
Throws and error if read after dispose and can be disposed on last unsubscribe.
finalinherited
debugLabel → String?
Debug label for Debug Mode
finalinherited
disposed ↔ bool
Returns true if dispose has been called and will throw and error on value read
getter/setter pairinherited
equalityCheck ↔ bool Function(Set<E> a, Set<E> b)
Optional method to check if to values are the same
getter/setter pairinherited
first → E
The first element.
no setterinherited
globalId → int
Global ID of the signal
finalinherited
hashCode → int
The hash code for this object.
no setteroverride
hasTargets → bool
Check if there are any targets attached
no setterinherited
initialValue → Set<E>
Value that the signal was created with
no setterinherited
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isInitialized → bool
Check if the signal is lazy and has not had a value set
no setterinherited
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
last → E
The last element.
no setterinherited
length → int
The number of elements in this Iterable.
no setterinherited
previousValue → Set<E>
Previous value that was set before the current
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 setterinherited
targets → Iterable<SignalListenable>
@internal for testing getter to track all the effects currently effected in the signal
no setterinherited
value ↔ Set<E>
Compute the current value
getter/setter pairinherited
version → int
Version number is used to track changes and will increment for every set
no setterinherited

Methods

add(E value) → bool
Adds value to the set.
override
addAll(Iterable<E> elements) → void
Adds all elements to this set.
override
any(bool test(E element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
call() → Set<E>
Return the value when invoked
inherited
cast<R>() → Set<R>
A view of this iterable as an iterable of R instances.
clear() → void
Removes all elements from the set.
override
contains(Object? value) → bool
Whether the collection contains an element equal to element.
inherited
containsAll(Iterable<Object?> other) → bool
Whether this set contains all the elements of other.
override
difference(Set<Object?> other) → Set<E>
Creates a new set with the elements of this that are not in other.
override
dispose() → void
Dispose the signal
inherited
elementAt(int index) → E
Returns the indexth element.
inherited
every(bool test(E element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(E element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(E element), {E orElse()?}) → E
The first element that satisfies the given predicate test.
inherited
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
forceUpdate([Set<E>? val]) → void
Force update a value
inherited
forEach(void action(E element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
get() → Set<E>
Get the current value
inherited
intersection(Set<Object?> other) → Set<E>
Creates a new set which is the intersection between this set and other.
override
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(E element), {E orElse()?}) → E
The last element that satisfies the given predicate test.
inherited
lookup(Object? object) → E?
If an object equal to object is in the set, return it.
override
map<T>(T toElement(E e)) → 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(void cleanup()) → EffectCleanup
Add a cleanup function to be called when the signal is disposed
inherited
overrideWith(Set<E> val) → Signal<Set<E>>
Override the current signal with a new value as if it was created with it
inherited
peek() → Set<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<Set<E>>
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.
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
set(Set<E> val, {bool force = false}) → bool
Update the current value.
inherited
singleWhere(bool test(E element), {E orElse()?}) → E
The single element that satisfies test.
inherited
skip(int count) → 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
subscribe(void fn(Set<E> value)) → EffectCleanup
Subscribe to value changes
inherited
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>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toJson() → dynamic
Convert value to JSON
inherited
toList({bool growable = true}) → List<E>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<E>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
A string representation of this object.
inherited
union(Set<E> other) → Set<E>
Creates a new set which contains all the elements of this set and other.
override
where(bool test(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 &(Set<E> other) → SetSignal<E>
Fork: create a new signal with value is the concatenation of source signal and iterable parameter
operator <<(Set<E> other) → SetSignal<E>
Inject: Update current signal value with iterable
operator ==(Object other) → bool
The equality operator.
override
operator |(Signal<Iterable<E>> other) → SetSignal<E>
Pipe: create a new signal by sending value from source to other