RxList<E> class

Create a list similar to List<T>

Inheritance
Implemented types
Mixed-in types
Available extensions

Constructors

RxList([List<E> initial = const []])
RxList.empty({bool growable = false})
factory
RxList.filled(int length, E fill, {bool growable = false})
factory
RxList.from(Iterable elements, {bool growable = true})
Creates a list containing all elements.
factory
RxList.generate(int length, E generator(int index), {bool growable = true})
Generates a list of values.
factory
RxList.of(Iterable<E> elements, {bool growable = true})
Creates a list from elements.
factory
RxList.unmodifiable(Iterable elements)
Creates an unmodifiable list containing all elements.
factory

Properties

canUpdate → bool
no setterinherited
first ↔ E
The first element.
getter/setter pairinherited
firstOrNull → T?

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

The first element, or null if the iterable is empty.
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
firstRebuild ↔ bool
getter/setter pairinherited
hashCode → int
The hash code for this object.
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>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
last ↔ E
The last element.
getter/setter pairinherited
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 objects in this list.
getter/setter pairoverride
nonNulls → Iterable<T>

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

The non-null elements of this iterable.
no setter
obs → RxList<E>

Available on List<E>, provided by the ListExtension extension

no setter
reversed → Iterable<E>
An Iterable of the objects in this list in reverse order.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sentToStream ↔ bool
getter/setter pairinherited
single → E
Checks that this iterable has only one element, and returns that element.
no setterinherited
singleOrNull → T?

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

The single element of this iterator, or null.
no setter
stream → Stream<List<E>>
no setterinherited
string → String
Same as toString() but using a getter.
no setterinherited
subject ↔ GetStream<List<E>>
getter/setter pairinherited
toJS → JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or cloning the List.
no setter
toJSProxyOrRef → JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or proxying the List.
no setter
value ↔ List<E>
Returns the current value
getter/setter pairinherited-setteroverride-getter
wait → Future<List<T>>

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

Waits for futures in parallel.
no setter

Methods

add(E element) → void
Adds value to the end of this list, extending the length by one.
override
addAll(Iterable<E> iterable) → void
Appends all objects of iterable to the end of this list.
override
addAllIf(dynamic condition, Iterable<E> items) → void

Available on List<E>, provided by the ListExtension extension

Adds Iterable<E> to List<E> only if condition is true.
addIf(dynamic condition, E item) → void

Available on List<E>, provided by the ListExtension extension

Add item to List< E > only if condition is true.
addListener(GetStream<List<E>> rxGetx) → void
This is an internal method. Subscribe to changes on the inner stream.
inherited
addNonNull(E item) → void

Available on List<E>, provided by the ListExtension extension

Add item to List<E> only if item is not null.
any(bool test(E element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
asMap() → Map<int, E>
An unmodifiable Map view of this list.
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.
assign(E item) → void

Available on List<E>, provided by the ListExtension extension

Replaces all existing items of this list with item
assignAll(Iterable<E> items) → void

Available on List<E>, provided by the ListExtension extension

Replaces all existing items of this list with items
bindStream(Stream<List<E>> stream) → void
Binds an existing Stream<T> to this Rx<> to keep the values in sync. You can bind multiple sources to update the value. Closing the subscription will happen automatically when the observer Widget (GetX or Obx) gets unmounted from the Widget tree.
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([List<E>? v]) → List<E>
updates the value to null and adds it to the Stream. Even with null-safety coming, is still an important feature to support, as call() doesn't accept null values. For instance, InputDecoration.errorText has to be null to not show the "error state".
inherited
cast<R>() → List<R>
Returns a view of this list as a list of R instances.
inherited
chunkSort({int chunkSize = 1000, bool descending = false}) → List<T>

Available on List<T>, provided by the ListSortExtension extension

Chunk sort - sorts the list in chunks of specified size Useful for sorting large lists in smaller batches Example:
clear() → void
Removes all objects from this list; the length of the list becomes zero.
inherited
close() → void
Closes the subscriptions for this Rx, releasing the resources.
inherited
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → E
Returns the indexth element.
inherited
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
expand<T>(Iterable<T> f(E element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
fillRange(int start, int end, [E? fill]) → void
Overwrites a range of elements with fillValue.
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
forEach(void action(E element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
getRange(int start, int end) → Iterable<E>
Creates an Iterable that iterates over a range of elements.
inherited
indexOf(Object? element, [int start = 0]) → int
The first index of element in this list.
inherited
indexWhere(bool test(E element), [int start = 0]) → int
The first index in the list that satisfies the provided test.
inherited
insert(int index, E element) → void
Inserts element at position index in this list.
inherited
insertAll(int index, Iterable<E> iterable) → void
Inserts all objects of iterable at position index in this list.
override
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastIndexOf(Object? element, [int? start]) → int
The last index of element in this list.
inherited
lastIndexWhere(bool test(E element), [int? start]) → int
The last index in the list that satisfies the provided test.
inherited
lastWhere(bool test(E element), {E orElse()?}) → E
The last element that satisfies the given predicate test.
inherited
listen(void onData(List<E>), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<List<E>>
inherited
listenAndPump(void onData(List<E> event), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<List<E>>
Returns a StreamSubscription similar to listen, but with the added benefit that it primes the stream with the current value, rather than waiting for the next value. This should not be called in onInit or anywhere else during the build process.
inherited
map<T>(T f(E element)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
mapMany<TRes>(Iterable<TRes>? selector(T item)) → Iterable<TRes>

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

Maps each element of the iterable to an iterable and flattens the result
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pickAfterRoute(String route) → Iterable<GetPage>

Available on List<GetPage>, provided by the PagesListExt extension

Returns all pages after the specified route (exclusive)
pickAtRoute(String route) → Iterable<GetPage>

Available on List<GetPage>, provided by the PagesListExt extension

Returns all pages starting from the specified route (inclusive)
reduce(E combine(E previousValue, E element)) → E
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
refresh() → void
Makes a direct update of value adding it to the Stream useful when you make use of Rx for custom Types to referesh your UI.
inherited
remove(Object? element) → bool
Removes the first occurrence of value from this list.
inherited
removeAt(int index) → E
Removes the object at position index from this list.
inherited
removeLast() → E
Removes and returns the last object in this list.
inherited
removeRange(int start, int end) → void
Removes a range of elements from the list.
inherited
removeWhere(bool test(E element)) → void
Removes all objects from this list that satisfy test.
override
replaceRange(int start, int end, Iterable<E> newContents) → void
Replaces a range of elements with the elements of replacements.
inherited
retainWhere(bool test(E element)) → void
Removes all objects from this list that fail to satisfy test.
override
setAll(int index, Iterable<E> iterable) → void
Overwrites elements with the objects of iterable.
inherited
setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) → void
Writes some elements of iterable into a range of this list.
inherited
shuffle([Random? random]) → void
Shuffles the elements of this list randomly.
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 element)) → Iterable<E>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
sort([int compare(E a, E b)?]) → void
Sorts this list according to the order specified by the compare function.
override
sortByField<K extends Comparable>(K field(T), {bool descending = false}) → List<T>

Available on List<T>, provided by the ListSortExtension extension

Sort by a specific field Returns a new sorted list based on the provided field selector Example:
sortByMultipleFields(List<Comparator<T>> comparators) → List<T>

Available on List<T>, provided by the ListSortExtension extension

Sort by multiple fields Returns a new sorted list based on multiple comparison functions Example:
sortList({bool descending = false}) → List<T>

Available on List<T>, provided by the ListSortExtension extension

Regular list sort Returns a new sorted list without modifying the original Example:
sortUnique({bool descending = false}) → List<T>

Available on List<T>, provided by the ListSortExtension extension

Sort and remove duplicates Returns a new sorted list with duplicate elements removed Example:
sortWithComparison(Comparator<T> comparison) → List<T>

Available on List<T>, provided by the ListSortExtension extension

Sort with custom comparison Returns a new sorted list using a custom comparison function Example:
sublist(int start, [int? end]) → List<E>
Returns a new list containing the elements between start and end.
inherited
take(int count) → Iterable<E>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(E element)) → Iterable<E>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toJson() → dynamic
Returns the json representation of value.
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
where(bool test(E)) → Iterable<E>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
override
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
override

Operators

operator +(Iterable<E> val) → RxList<E>
Special override to push() element(s) in a reactive way inside the List,
override
operator ==(Object o) → bool
This equality override works for _RxImpl instances and the internal values.
inherited
operator [](int index) → E
The object at the given index in the list.
override
operator []=(int index, E val) → void
Sets the value at the given index in the list to value.
override