ListSet<T> class

A ListSet is, at the same time:

A mutable, fixed-sized, ordered, Set.
A mutable, fixed-sized, List, in which values can't repeat.

When viewed as a Set and compared to a LinkedHashSet, a ListSet is also ordered and has a similar performance. But a ListSet takes less memory and can be sorted, just like a list. Also, you can directly get its items by index. The disadvantage, of course, is that ListSet has a fixed size, while a LinkedHashSet does not.

The ListSet is efficient both as a List and as a Set. So, for example, it has an efficient sort method, while a LinkedHashSet would force you to turn it into a List, then sort it, than turn it back into a Set.

Implemented types

Set<T>
List<T>

Implementers

ListSetView

Available extensions

Constructors

ListSet.empty()
ListSet.fromJson(dynamic json, T fromJsonT(Object?)): Converts from JSon. Json serialization support for json_serializable with @JsonSerializable.
factory
ListSet.of(Iterable<T> items, {bool sort = false, int compare(T a, T b)?}): Create a ListSet from the items iterable.

Properties

asComparableEntries → Iterable<Entry<K, V>>: Available on Iterable<MapEntry<K, V>>, provided by the FicIterableOfMapEntryExtension extension
MapEntry is not Comparable. If you need to compare two iterables of MapEntry you can do this:
no setter
first ↔ T: The first element.
getter/setter pairoverride
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
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 setteroverride
isNotEmpty → bool: Whether this collection has at least one element.
no setteroverride
iterator → Iterator<T>: An iterator that iterates over the elements of this set.
no setteroverride
last ↔ T: The last element.
getter/setter pairoverride
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.
getter/setter pairoverride
lock → IList<T>: Available on List<T>, provided by the FicListExtension extension
Locks the list, returning an immutable list (IList).
no setter
lock → ISet<T>: Available on Set<T>, provided by the FicSetExtension extension
Locks the set, returning an immutable set (ISet).
no setter
lockUnsafe → IList<T>: Available on List<T>, provided by the FicListExtension extension
Locks the list, returning an immutable list (IList).
no setter
lockUnsafe → ISet<T>: Available on Set<T>, provided by the FicSetExtension extension
Locks the set, returning an immutable set (ISet).
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<T>: An Iterable of the objects in this list in reverse order.
no setteroverride
reversedView → ListSet<T>: no setter
reversedView → List<T>: Available on List<T>, provided by the FicListExtension extension
Returns a List of the objects in this list in reverse order. Very efficient since it returns a view (which means, if you change the original list this one will also change, and vice-versa).
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
single → T: 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
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
wait → Future<List<T>>: Available on Iterable<Future<T>>, provided by the FutureIterable extension
Waits for futures in parallel.
no setter

Methods

add(T value) → bool: Adds value to the set.
override
addAll(Iterable<T> elements) → void: Adds all elements to this set.
override
addBetween(T separator) → List<T>: Available on List<T>, provided by the FicListExtension extension
Return a new list, adding a separator between the original list items (but not before the first and after the last).
any(Predicate<T> test) → bool: Checks whether any element of this iterable satisfies test.
override
anyIs(T value) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Returns true if any item is equal to value.
asList() → List<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Returns a List containing the elements of this iterable. If the Iterable is already a List, return the same instance (nothing new is created). Otherwise, create a new List from it. See also: Dart's native toList, which always creates a new list.
asMap() → Map<int, T>: An unmodifiable Map view of this list.
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.
asSet() → Set<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Creates a Set containing the same elements as this iterable. If the Iterable is already a Set, return the same instance (nothing new is created). Otherwise, create a new Set from it. See also: Dart's native toSet, which always creates a new set.
averageBy<N extends num>(N mapper(T element)) → double: Available on Iterable<T>, provided by the FicIterableExtension extension
The arithmetic mean of the elements of a non-empty iterable. The arithmetic mean is the sum of the elements divided by the number of elements. If iterable is empty it returns 0. Examples:
byName(String name) → T: Available on Iterable<T>, provided by the EnumByName extension
Finds the enum value in this list with name name.
cast<E>() → ListSet<E>: Provides a view of this set as a set of R instances.
override
clear() → void: Removes all elements from the set.
override
compareAsSets(List other) → bool: Available on List<T>, provided by the FicListExtension extension
Return true if the lists contain the same items (in any order). Ignores repeated items.
concat(List<T>? list2, [List<T>? list3, List<T>? list4, List<T>? list5]) → List<T>: Available on List<T>, provided by the FicListExtension extension
Return an efficient concatenation of up to 5 lists:
contains(covariant T? value) → bool: Whether value is in the set.
override
containsAll(covariant Iterable<T?> other) → bool: Whether this set contains all the elements of other.
override
deepEquals(Iterable? other, {bool ignoreOrder = false}) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Compare all items, in order or not, according to ignoreOrder, using operator ==. Return true if they are all the same, in the same order.
deepEqualsByIdentity(Iterable? other, {bool ignoreOrder = false}) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Return true if they are all the same, in the same order. Compare all items, in order or not, according to ignoreOrder, using identical. Return true if they are all the same, in the same order.
diffAndIntersect<G>(Set<G> other, {bool diffThisMinusOther = true, bool diffOtherMinusThis = true, bool intersectThisWithOther = true, bool intersectOtherWithThis = true}) → DiffAndIntersectResult<T, G>: Available on Set<T>, provided by the FicSetExtension extension
Given this set and other, returns:
difference(covariant Set<T?> other) → Set<T>: Creates a new set with the elements of this that are not in other.
override
distinct({dynamic by(T item)?}) → List<T>: Available on List<T>, provided by the FicListExtension extension
Returns a new list, which is equal to the original one, but without duplicates. In other words, the new list has only distinct items. Optionally, you can provide an id function to compare the items.
divideList(Predicate<T> test) → List<List<T>>: Available on List<T>, provided by the FicListExtension extension
Search a list for items that satisfy a test predicate (matching items), and then divide that list into parts, such as each part contains one matching item. Except maybe for the first matching item, it will keep the matching items as the first item in each part.
divideListAsMap<G>(bool test(T item), {G key(T item)?, bool includeFirstItems = false}) → Map<G, List<T>>: Available on List<T>, provided by the FicListExtension extension
Search a list for items that satisfy a test predicate (matching items), and then divide that list into a Map of parts, such as each part contains one matching item, and the keys are given by the key function.
elementAt(int index) → T: 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(Predicate<T> test) → bool: Checks whether every element of this iterable satisfies test.
override
everyIs(T value) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Returns true if all items are equal to value.
expand<E>(Iterable<E> f(T element)) → Iterable<E>: Expands each element of this Iterable into zero or more elements.
override
fillRange(int start, int end, [T? fillValue]) → void: Overwrites a range of elements with fillValue.
override
findDuplicates() → Set<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Finds duplicates and then returns a Set with the duplicated elements. If there are no duplicates, an empty Set is returned.
firstWhere(Predicate<T> test, {T orElse()?}) → T: The first element that satisfies the given predicate test.
override
fold<E>(E initialValue, E combine(E previousValue, T element)) → E: Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
override
followedBy(Iterable<T> other) → Iterable<T>: Creates the lazy concatenation of this iterable and other.
override
forEach(void f(T element)) → void: Invokes action on each element of this iterable in iteration order.
override
get(int index, {T orElse(int index)?}) → T: Available on List<T>, provided by the FicListExtension extension
Returns the indexth element. If that index doesn't exist (negative, or out of range), will return the result of calling orElse. In this case, if orElse is not provided, will throw an error.
getAndMap(int index, T map(int index, bool inRange, T? value)) → T: Available on List<T>, provided by the FicListExtension extension
Gets the indexth element, and then apply the map function to it, returning the result. If that index doesn't exist (negative, or out of range), will the map method will be called with inRange false and value null.
getOrNull(int index) → T?: Available on List<T>, provided by the FicListExtension extension
Returns the indexth element. If that index doesn't exist (negative or out of range), will return null. This method will never throw an error.
getRange(int start, int end) → Iterable<T>: Creates an Iterable that iterates over a range of elements.
override
indexOf(T element, [int start = 0]) → int: The first index of element in this list.
override
indexWhere(Predicate<T> test, [int start = 0]) → int: The first index in the list that satisfies the provided test.
override
insert(int index, T element) → void: Inserts element at position index in this list.
override
insertAll(int index, Iterable<T> iterable) → void: Inserts all objects of iterable at position index in this list.
override
intersection(covariant Set<T?> other) → Set<T>: Creates a new set which is the intersection between this set and other.
override
intersectsWith(Iterable<T> other) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Returns true if this Iterable has any items in common with the other Iterable. This method is as performant as possible, but it will be faster if any of the Iterables is a Set or an ISet.
isFirst(T item) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Return true if the given item is the same (by identity) as the first iterable item. If this iterable is empty, always return null. This is useful for non-indexed loops where you need to know when you have the first item. For example:
isLast(T item) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Return true if the given item is the same (by identity) as the last iterable item. If this iterable is empty, always return null. This is useful for non-indexed loops where you need to know when you have the last item. For example:
isNotFirst(T item) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Return true if the given item is NOT the same (by identity) as the first iterable item. If this iterable is empty, always return null. This is useful for non-indexed loops where you need to know when you don't have the first item. For example:
isNotLast(T item) → bool: Available on Iterable<T>, provided by the FicIterableExtension extension
Return true if the given item is NOT the same (by identity) as the last iterable item. If this iterable is empty, always return null. This is useful for non-indexed loops where you need to know when you don't have the last item. For example:
join([String separator = ""]) → String: Converts each element to a String and concatenates the strings.
override
lastIndexOf(T element, [int? start]) → int: The last index of element in this list.
override
lastIndexWhere(Predicate<T> test, [int? start]) → int: The last index in the list that satisfies the provided test.
override
lastWhere(Predicate<T> test, {T orElse()?}) → T: The last element that satisfies the given predicate test.
override
lookup(Object? object) → T?: If an object equal to object is in the set, return it.
override
map<E>(E f(T e)) → Iterable<E>: The current elements of this iterable modified by toElement.
override
mapIndexedAndLast<R>(R convert(int index, T item, bool isLast)) → Iterable<R>: Available on Iterable<T>, provided by the FicIterableExtension extension
Maps each element and its index to a new value. This is similar to mapIndexed but also tells you which item is the last.
mapNotNull<E>(E? f(T? e)) → Iterable<E>: Available on Iterable<T?>, provided by the FicIterableExtensionTypeNullable extension
Similar to map, but MAY return a non-nullable type.
moveToTheEnd(T item) → void: Available on List<T>, provided by the FicListExtension extension
Moves the first occurrence of the item to the end of the list.
moveToTheFront(T item) → void: Available on List<T>, provided by the FicListExtension extension
Moves the first occurrence of the item to the start of the list.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
reduce(T combine(T value, T element)) → T: Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
override
remove(Object? value) → bool: Removes value from the set.
override
removeAll(Iterable<Object?> elements) → void: Removes each element of elements from this set.
override
removeAt(int index) → T: Removes the object at position index from this list.
override
removeDuplicates({dynamic by(T item)?, bool removeNulls = false}) → void: Available on List<T>, provided by the FicListExtension extension
Removes all duplicates from the list, leaving only the distinct items. Optionally, you can provide an id function to compare the items.
removeLast() → T: Removes and returns the last object in this list.
override
removeNulls() → void: Available on List<T>, provided by the FicListExtension extension
Removes all nulls from the List.
removeNulls() → void: Available on Set<T>, provided by the FicSetExtension extension
Removes all nulls from the Set.
removeRange(int start, int end) → void: Removes a range of elements from the list.
override
removeWhere(Predicate<T> test) → void: Removes all elements of this set that satisfy test.
override
replaceRange(int start, int end, Iterable<T> replacement) → void: Replaces a range of elements with the elements of replacements.
override
restrict(T? item, {required T orElse}) → T: Available on Iterable<T>, provided by the FicIterableExtension extension
Restricts some item to one of those present in this iterable.
retainAll(Iterable<Object?> elements) → void: Removes all elements of this set that are not elements in elements.
override
retainWhere(Predicate<T> test) → void: Removes all elements of this set that fail to satisfy test.
override
setAll(int index, Iterable<T> iterable) → void: Overwrites elements with the objects of iterable.
override
setRange(int start, int end, Iterable<T> iterable, [int skipCount = 0]) → void: Writes some elements of iterable into a range of this list.
override
shuffle([Random? random]) → void: Shuffles the elements of this list randomly.
override
singleWhere(Predicate<T> test, {T orElse()?}) → T: The single element that satisfies test.
override
skip(int count) → Iterable<T>: Creates an Iterable that provides all but the first count elements.
override
skipWhile(bool test(T value)) → Iterable<T>: Creates an Iterable that skips leading elements while test is satisfied.
override
sort([int compare(T a, T b)?]) → void: Sorts this list according to the order specified by the compare function.
override
sortedLike(Iterable ordering) → List<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Returns a list, sorted according to the order specified by the ordering iterable. Items which don't appear in ordering will be included in the end, in their original order. Items of ordering which are not found in the original list are ignored.
sortedReversed([Comparator<T>? compare]) → List<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Creates a reversed sorted list of the elements of the iterable.
sortLike(Iterable ordering) → void: Available on List<T>, provided by the FicListExtension extension
Sorts this list according to the order specified by the ordering iterable. Items which don't appear in ordering will be included in the end, in their original order. Items of ordering which are not found in the original list are ignored.
sortOrdered([int compare(T a, T b)?]) → void: Available on List<T>, provided by the FicListExtension extension
Sorts this list according to the order specified by the compare function.
sortReversed([int compare(T a, T b)?]) → void: Available on List<T>, provided by the FicListExtension extension
Sorts this list in reverse order in relation to the default sort method.
splitByLength(int length) → List<List<T>>: Available on List<T>, provided by the FicListExtension extension
Cut the original list into one or more lists with at most length items.
splitList(bool test(T item), {bool emptyParts = false}) → Iterable<List<T>>: Available on List<T>, provided by the FicListExtension extension
Split a list, according to a predicate, removing the list item that satisfies the predicate.
sublist(int start, [int? end]) → List<T>: Returns a new list containing the elements between start and end.
override
sumBy<N extends num>(N mapper(T element)) → N: Available on Iterable<T>, provided by the FicIterableExtension extension
The sum of the values returned by the mapper function.
take(int count) → Iterable<T>: Creates a lazy iterable of the count first elements of this iterable.
override
takeWhile(bool test(T value)) → Iterable<T>: Creates a lazy iterable of the leading elements satisfying test.
override
toggle(T item) → bool: Available on List<T>, provided by the FicListExtension extension
If the item does not exist in the list, add it and return true. If it already exists, remove the first instance of it and return false.
toggle(T item) → bool: Available on Set<T>, provided by the FicSetExtension extension
If the item doesn't exist in the set, add it and return true. Otherwise, if the item already exists in the set, remove it and return false.
toIList([ConfigList? config]) → IList<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Creates an immutable list (IList) from the iterable.
toISet([ConfigSet? config]) → ISet<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Creates an immutable set (ISet) from the iterable.
toJson(Object? toJsonT(T)) → Object: Converts to JSon. Json serialization support for json_serializable with @JsonSerializable.
toList({bool growable = true}) → List<T>: Creates a List containing the elements of this Iterable.
override
toSet() → Set<T>: Creates a Set with the same elements and behavior as this Set.
override
toString() → String: A string representation of this object.
inherited
union(covariant Set<T> other) → Set<T>: Creates a new set which contains all the elements of this set and other.
override
unzip() → (Iterable<U>, Iterable<V>): Available on Iterable<(U, V)>, provided by the FICZipExtension extension
Iterable Record as Iterable
updateById(Iterable<T> newItems, dynamic id(T item)) → List<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Returns a new list where newItems are added or updated, by their id (and the id is a function of the item), like so:
where(Predicate<T> test) → Iterable<T>: Creates a new lazy Iterable with all elements that satisfy the predicate test.
override
whereMoveToTheEnd(bool test(T item)) → void: Available on List<T>, provided by the FicListExtension extension
Moves all items that satisfy the provided test to the end of the list. Keeps the relative order of the moved items.
whereMoveToTheFront(bool test(T item)) → void: Available on List<T>, provided by the FicListExtension extension
Moves all items that satisfy the provided test to the start of the list. Keeps the relative order of the moved items.
whereNoDuplicates({dynamic by(T item)?, bool removeNulls = false}) → Iterable<T>: Available on Iterable<T>, provided by the FicIterableExtension extension
Removes all duplicates, leaving only the distinct items. Optionally, you can provide an by function to compare the items.
whereType<E>() → Iterable<E>: Creates a new lazy Iterable with all elements that have type T.
override
withNullsRemoved() → List<T>: Available on List<T?>, provided by the FicListExtensionNullable extension
Returns a new List with all nulls removed. This may return a list with a non-nullable type.

Operators

operator +(List<T> other) → ListSet<T>: Returns the concatenation of this list and other.
override
operator ==(Object other) → bool: The equality operator.
inherited
operator [](int index) → T: The object at the given index in the list.
override
operator []=(int index, T value) → void: Sets the value at the given index in the list to value.
override

Static Methods

unsafeView<T>(Set<T> set) → ListSet<T>: Creates a ListSet form the given set. If the set is already of type ListSet, return the same instance. This is unsafe because a ListSetView is fixed size, but the given set may not.