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

MutableReactiveList

interface MutableReactiveList<E> : MutableReactiveCollection<E, List<E>, MutableList<E>> , MutableList<E>

A mutable list that also exposes a StateFlow via asStateFlow, allowing for reactive observation of its contents.

It delegates MutableList functionality to an internal list and emits an immutable List snapshot to its collectors whenever the list is modified.

Parameters

The type of elements contained in the list.

Properties

size

abstract override val size: Int

Functions

add

abstract override fun add(element: E): Boolean

abstract fun add(index: Int, element: E)

addAll

abstract override fun addAll(elements: Collection<E>): Boolean

abstract fun addAll(index: Int, elements: Collection<E>): Boolean

asStateFlow

abstract fun asStateFlow(): StateFlow<List<E>>

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

batchUpdate

abstract fun batchUpdate(block: MutableList<E>.() -> Unit)

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

batchUpdateAsync

abstract suspend fun batchUpdateAsync(block: suspend MutableList<E>.() -> Unit)

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

clear

abstract override fun clear()

contains

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

containsAll

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

get

abstract operator fun get(index: Int): E

getAsFlow

fun <E> MutableReactiveList<E>.getAsFlow(index: Int): Flow<E?>

Creates a Flow that emits the element at the specified index whenever the list changes.

indexOf

abstract fun indexOf(element: E): Int

isEmpty

abstract override fun isEmpty(): Boolean

iterator

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

lastIndexOf

abstract fun lastIndexOf(element: E): Int

listIterator

abstract override fun listIterator(): MutableListIterator<E>

abstract override fun listIterator(index: Int): MutableListIterator<E>

remove

abstract override fun remove(element: E): Boolean

removeAll

abstract override fun removeAll(elements: Collection<E>): Boolean

removeAt

abstract fun removeAt(index: Int): E

retainAll

abstract override fun retainAll(elements: Collection<E>): Boolean

set

abstract operator fun set(index: Int, element: E): E

subList

abstract override fun subList(fromIndex: Int, toIndex: Int): MutableList<E>

subListAsFlow

fun <E> MutableReactiveList<E>.subListAsFlow(fromIndex: Int, toIndex: Int, strict: Boolean = true): Flow<List<E>>

Returns a Flow that emits a sublist view of this reactive list between the specified fromIndex (inclusive) and toIndex (exclusive).

toMutableReactiveList

fun <E> Collection<E>.toMutableReactiveList(): MutableReactiveList<E>

fun <E> MutableList<E>.toMutableReactiveList(): MutableReactiveList<E>

Returns a new MutableReactiveList filled with all elements of this collection.

toMutableReactiveSet

fun <E> Collection<E>.toMutableReactiveSet(): MutableReactiveSet<E>

Returns a new MutableReactiveSet filled with all elements of this collection.