ProduceStateScope

Artifact: androidx.compose.runtime:runtime

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  interface ProduceStateScope<T : Any?> : MutableState, CoroutineScope

---

Receiver scope for use with produceState.

Summary

Public functions
suspend Nothing	awaitDispose(onDispose: () -> Unit) Await the disposal of this producer whether it left the composition, the source changed, or an error occurred.	Cmn

Inherited functions
From androidx.compose.runtime.MutableState operator T component1() Cmn operator (T) -> Unit component2() Cmn

Inherited properties
From kotlinx.coroutines.CoroutineScope CoroutineContext coroutineContext Cmn
From androidx.compose.runtime.MutableState T value Cmn

Public functions

awaitDispose

Cmn

suspend fun awaitDispose(onDispose: () -> Unit): Nothing

Await the disposal of this producer whether it left the composition, the source changed, or an error occurred. Always runs onDispose before resuming.

This method is useful when configuring callback-based state producers that do not suspend, for example:

import androidx.compose.runtime.produceState

val currentPerson by
    produceState<Person?>(null, viewModel) {
        val disposable = viewModel.registerPersonObserver { person -> value = person }

        awaitDispose { disposable.dispose() }
    }