CollectiveQueueAsync<E> class

An asynchronous interface for performing operations on a CollectiveQueue.

This class provides Future-based versions of all CollectiveQueue operations, allowing queue modifications to be used in async/await contexts while maintaining:

Full reactive behavior and cell linkages
All validation rules from the original queue
Automatic change notifications
Transactional safety

All operations return Futures that complete when:

The operation has been validated
The queue has been modified
All change notifications have been processed

Example Usage:

final queue = CollectiveQueue<int>().async;

Future<void> fillQueue() async {
  await queue.add(1);
  await queue.addFirst(0);  // Add to front
  await queue.addAll([2, 3]);
}

Inheritance

Implemented types

CollectiveQueue<E>

Implementers

UnmodifiableCollectiveQueueAsync

Available extensions

Constructors

CollectiveQueueAsync.new(CollectiveQueue<E> collective): Creates an async variant of CollectiveQueue for modifiable methods.
const

Properties

async → CollectiveQueueAsync<E>: Creates a Async CollectiveQueue for async modifiable operations
no setteroverride
first → E: The first element.
no setterinherited
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 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
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.
no setterinherited
modifiable → Iterable<Function>: Returns an iterable containing modifiable functions.
no setterinherited
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 setterinherited
singleOrNull → T?: Available on Iterable<T>, provided by the IterableExtensions extension
The single element of this iterator, or null.
no setter
test → TestCollective<dynamic, Collective>: Gets the test object associated with the cell.
no setteroverride
unmodifiable → CollectiveQueue<E>: Gets an unmodifiable view of this queue.
no setteroverride
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) → Future<void>: Async adds value to the queue.
override
addAll(Iterable<E> iterable) → Future<void>: Async adds all iterable to the queue.
override
addFirst(E value) → Future<void>: Async add the element to the first in the queue.
override
addLast(E value) → Future<void>: Async add the element to the last in the queue.
override
any(bool test(E element)) → bool: Checks whether any element of this iterable satisfies test.
inherited
apply(Function function, List? positionalArguments, [Map<Symbol, dynamic>? namedArguments]) → Future: Asynchronously applies a function through the cell's validation system.
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.
cast<R>() → Queue<R>: A view of this iterable as an iterable of R instances.
override
clear() → Future<void>: Async removes all elements from the queue.
override
contains(Object? element) → bool: Whether the collection contains an element equal to element.
inherited
deputy({covariant TestCollective<dynamic, Collective>? test, covariant MapObject? mapObject}) → CollectiveQueue<E>: Creates a delegated view with modified behavior.
override
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> 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
forEach(void action(E element)) → void: Invokes action on each element of this iterable in iteration order.
inherited
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
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
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) → Future<bool>: Async removes a single instance of value from the queue
override
removeFirst() → Future<E>: Async removes the first element from the queue.
override
removeLast() → Future<E>: Async removes the last element from the queue.
override
removeWhere(bool test(E element)) → Future<void>: Async removes elements from the queue that satisfy the test.
override
retainWhere(bool test(E element)) → Future<void>: Async removes elements from the queue that doesn't satisfy the test.
override
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
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
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: Returns a string representation of (some of) the elements of this.
inherited
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 ==(Object other) → bool: The equality operator.
inherited

CollectiveQueueAsync<E> class

Constructors

Properties

Methods

Operators

cell.collection library