SnapshotStateSet


An implementation of MutableSet that can be observed and snapshot. This is the result type created by androidx.compose.runtime.mutableStateSetOf.

Summary

Public constructors

android
Cmn
android

Public functions

open Boolean
add(element: T)
Cmn
android
open Boolean
addAll(elements: Collection<T>)
Cmn
android
open Unit
Cmn
android
open operator Boolean
contains(element: T)
Cmn
android
open Boolean
containsAll(elements: Collection<T>)
Cmn
android
open Int
android
open Boolean
Cmn
android
open operator MutableIterator<T>
Cmn
android
open Unit

Add a new state record to the beginning of a list.

Cmn
android
open Boolean
remove(element: T)
Cmn
android
open Boolean
removeAll(elements: Collection<T>)
Cmn
android
open Boolean
retainAll(elements: Collection<T>)
Cmn
android
Set<T>

Return a set containing all the elements of this set.

Cmn
android
open String
android
open String
android
open Unit
writeToParcel(parcel: Parcel, flags: Int)
android

Public properties

open StateRecord

The first state record in a linked list of state records.

Cmn
android
open Int
Cmn
android

Inherited functions

From kotlin.collections.Collection
open Stream<T>
android
open Stream<T>
android
open Stream<T>
android
open Stream<T>
android
open Array<T>

This function is deprecated. This member is not fully supported by Kotlin compiler, so it may be absent or have different signature in next major version

android
open Array<T>

This function is deprecated. This member is not fully supported by Kotlin compiler, so it may be absent or have different signature in next major version

android
From kotlin.collections.Iterable
open Unit
android
open Unit
android
From kotlin.collections.MutableCollection
open Boolean
android
open Boolean
android
From kotlin.collections.Set
From androidx.compose.runtime.snapshots.StateObject
open StateRecord?
mergeRecords(
    previous: StateRecord,
    current: StateRecord,
    applied: StateRecord
)

Produce a merged state based on the conflicting state changes.

android
open StateRecord?
mergeRecords(
    previous: StateRecord,
    current: StateRecord,
    applied: StateRecord
)

Produce a merged state based on the conflicting state changes.

Cmn
open StateRecord?
mergeRecords(
    previous: StateRecord,
    current: StateRecord,
    applied: StateRecord
)

Produce a merged state based on the conflicting state changes.

android

Public constructors

SnapshotStateSet

<T : Any?> SnapshotStateSet()

SnapshotStateSet

<T : Any?> SnapshotStateSet()

SnapshotStateSet

<T : Any?> SnapshotStateSet()

Public functions

add

open fun add(element: T): Boolean

addAll

open fun addAll(elements: Collection<T>): Boolean

clear

open fun clear(): Unit

contains

open operator fun contains(element: T): Boolean

containsAll

open fun containsAll(elements: Collection<T>): Boolean

describeContents

open fun describeContents(): Int

isEmpty

open fun isEmpty(): Boolean

iterator

open operator fun iterator(): MutableIterator<T>

prependStateRecord

open fun prependStateRecord(value: StateRecord): Unit

Add a new state record to the beginning of a list. After this call firstStateRecord should be value.

remove

open fun remove(element: T): Boolean

removeAll

open fun removeAll(elements: Collection<T>): Boolean

retainAll

open fun retainAll(elements: Collection<T>): Boolean

toSet

fun toSet(): Set<T>

Return a set containing all the elements of this set.

The set returned is immutable and returned will not change even if the content of the set is changed in the same snapshot. It also will be the same instance until the content is changed. It is not, however, guaranteed to be the same instance for the same set as adding and removing the same item from the this set might produce a different instance with the same content.

This operation is O(1) and does not involve a physically copying the set. It instead returns the underlying immutable set used internally to store the content of the set.

It is recommended to use toSet when returning the value of this set from androidx.compose.runtime.snapshotFlow.

toString

open fun toString(): String

toString

open fun toString(): String

writeToParcel

open fun writeToParcel(parcel: Parcel, flags: Int): Unit

Public properties

firstStateRecord

open val firstStateRecordStateRecord

The first state record in a linked list of state records.

size

open val sizeInt