collections/com.juul.tuulbox.collections/AtomicSet

AtomicSet

A Set that allows for thread safe, atomic mutation. Returned iterator references a snapshot of when this was accessed, and is not mutated when the set is.

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

Constructors

AtomicSet

constructor(initial: PersistentSet<E>)

Construct an AtomicSet with initial set.

Properties

size

open override val size: Int

snapshot

val snapshot: ImmutableSet<E>

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

snapshots

val snapshots: StateFlow<ImmutableSet<E>>

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

Functions

contains

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

containsAll

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

equals

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

hashCode

open override fun hashCode(): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

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

mutate

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

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

mutateAndSnapshot

inline fun mutateAndSnapshot(mutator: MutableSet<E>.() -> Unit): ImmutableSet<E>

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

snapshotAndMutate

inline fun snapshotAndMutate(mutator: MutableSet<E>.() -> Unit): ImmutableSet<E>

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

toString

open override fun toString(): String