reactive-collections/dev.shreyaspatil.reactivecollections.core/MutableReactiveCollection

MutableReactiveCollection

interface MutableReactiveCollection<E, out IC, out MC : IC>

A foundational interface for mutable collections that expose their state as a StateFlow.

This allows observers to reactively receive updates whenever the collection is modified. The emitted value is an immutable snapshot of the collection at the time of modification.

Parameters

The type of elements in the collection.

The type of immutable collection snapshot emitted by the StateFlow (e.g., List, Set, Map).

The underlying mutable collection type that this interface wraps (e.g., MutableList, MutableSet, MutableMap).

Inheritors

MutableReactiveList

MutableReactiveMap

MutableReactiveSet

Functions

asStateFlow

abstract fun asStateFlow(): StateFlow<IC>

Returns the collection's content as a StateFlow of an immutable collection IC type.

batchNotify

abstract fun batchNotify(block: MC.() -> Unit)

Executes a block of modifications on the underlying mutable collection and notifies observers only once after the block has completed.

batchNotifyAsync

abstract suspend fun batchNotifyAsync(block: suspend MC.() -> Unit)

Executes a suspending block of modifications on the underlying mutable collection and notifies observers only once after the block has completed.