collections/com.juul.tuulbox.collections/AtomicList

AtomicList

class AtomicList<E> : List<E>

A List that allows for thread safe, atomic mutation. Returned collections such as iterator and subList reference a snapshot of when they were accessed, and are not mutated when the list is.

Although mutable, this class intentionally does not implement MutableList. Mutation must use designated mutator functions (mutate, snapshotAndMutate, mutateAndSnapshot).

Constructors

constructor(initial: PersistentList<E>)

Construct an AtomicList with initial list.

Properties

open override val size: Int

val snapshot: ImmutableList<E>

Returns the current value of this List as an immutable snapshot.

val snapshots: StateFlow<ImmutableList<E>>

Returns this list as a StateFlow. Each mutation will cause a new emission on this flow.

Functions

open operator override fun contains(element: E): Boolean

open override fun containsAll(elements: Collection<E>): Boolean

open operator override fun equals(other: Any?): Boolean

open operator override fun get(index: Int): E

open override fun hashCode(): Int

open override fun indexOf(element: E): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): Iterator<E>

open override fun lastIndexOf(element: E): Int

open override fun listIterator(): ListIterator<E>

open override fun listIterator(index: Int): ListIterator<E>

inline fun mutate(mutator: MutableList<E>.() -> Unit)

Mutates this List atomically. mutator can be evaluated multiple times if a concurrent edit occurs.

mutateAndSnapshot

inline fun mutateAndSnapshot(mutator: MutableList<E>.() -> Unit): ImmutableList<E>

Mutates this List atomically and returns the new snapshot. mutator can be evaluated multiple times if a concurrent edit occurs.

snapshotAndMutate

inline fun snapshotAndMutate(mutator: MutableList<E>.() -> Unit): ImmutableList<E>

Mutates this List atomically and returns the previous snapshot. mutator can be evaluated multiple times if a concurrent edit occurs.

open override fun subList(fromIndex: Int, toIndex: Int): ImmutableList<E>

open override fun toString(): String