BuiltSet<E> class abstract

The Built Collection Set.

It implements Iterable and the non-mutating part of the Set interface. Iteration is in the same order in which the elements were inserted. Modifications are made via SetBuilder.

See the Built Collection library documentation for the general properties of Built Collections.

Implemented types
Available extensions

Constructors

BuiltSet([Iterable iterable = const []])
Instantiates with elements from an Iterable.
factory
BuiltSet.build(dynamic updates(SetBuilder<E>))
Creates a SetBuilder, applies updates to it, and builds.
factory
BuiltSet.from(Iterable iterable)
Instantiates with elements from an Iterable.
factory
BuiltSet.of(Iterable<E> iterable)
Instantiates with elements from an Iterable<E>.
factory

Properties

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
Deep hashCode.
no setteroverride
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<E>
A new Iterator that allows iterating the elements of this Iterable.
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
As Set.length.
no setteroverride
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 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
wait → Future<List<T>>

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

Waits for futures in parallel.
no setter

Methods

any(bool test(E)) → 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.
asSet() → Set<E>
Returns as an immutable set.
byName(String name) → T

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

Finds the enum value in this list with name name.
cast<T>() → Iterable<T>
A view of this iterable as an iterable of R instances.
override
contains(Object? element) → bool
Whether the collection contains an element equal to element.
override
containsAll(Iterable<Object?> other) → bool
As Set.containsAll.
difference(BuiltSet<Object?> other) → BuiltSet<E>
As Set.difference but takes a BuiltSet<Object?> and returns a BuiltSet<E>.
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)) → bool
Checks whether every element of this iterable satisfies test.
override
expand<T>(Iterable<T> f(E)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
override
firstWhere(bool test(E), {E orElse()?}) → E
The first element that satisfies the given predicate test.
override
fold<T>(T initialValue, T combine(T, E)) → T
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 f(E)) → void
Invokes action on each element of this iterable in iteration order.
override
intersection(BuiltSet<Object?> other) → BuiltSet<E>
As Set.intersection but takes a BuiltSet<Object?> and returns a BuiltSet<E>.
join([String separator = '']) → String
Converts each element to a String and concatenates the strings.
override
lastWhere(bool test(E), {E orElse()?}) → E
The last element that satisfies the given predicate test.
override
lookup(Object? object) → E?
As Set.lookup.
map<T>(T f(E)) → Iterable<T>
The current elements of this iterable modified by toElement.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(SetBuilder<E>)) → BuiltSet<E>
Converts to a SetBuilder, applies updates to it, and builds.
reduce(E combine(E, E)) → E
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
override
singleWhere(bool test(E), {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.
override
skipWhile(bool test(E)) → Iterable<E>
Creates an Iterable that skips leading elements while test is satisfied.
override
take(int n) → Iterable<E>
Creates a lazy iterable of the count first elements of this iterable.
override
takeWhile(bool test(E)) → Iterable<E>
Creates a lazy iterable of the leading elements satisfying test.
override
toBuilder() → SetBuilder<E>
Converts to a SetBuilder for modification.
toBuiltList() → BuiltList<E>
Converts to a BuiltList.
toBuiltList() → BuiltList<E>

Available on Iterable<E>, provided by the BuiltListIterableExtension extension

Converts to a BuiltList.
toBuiltSet() → BuiltSet<E>
Converts to a BuiltSet.
toBuiltSet() → BuiltSet<E>

Available on Iterable<E>, provided by the BuiltSetIterableExtension extension

Converts to a BuiltSet.
toList({bool growable = true}) → List<E>
Creates a List containing the elements of this Iterable.
override
toSet() → Set<E>
As Iterable.toSet.
override
toString() → String
A string representation of this object.
override
union(BuiltSet<E> other) → BuiltSet<E>
As Set.union but takes and returns a BuiltSet<E>.
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 ==(Object other) → bool
Deep equality.
override