Search code examples
kotlingenericskotlin-coroutineskotlin-stateflow

Suspending until StateFlow reaches one of the desired states and returning the result

Consider a sealed class State.

sealed class State {
    object Unknown : State()
    object Loading : State()
    object Success : State()
    data class Failure(val exception: Exception)
}

I have a stateflow where consumers can actively listen to the state updates.

val state:State = MutableStateFlow(State.Unknown)

Now, I also want to have a simple suspend method which waits till the state reaches either Success or Failure, so consumers who just need the result once need not be aware of the stateflow.

How to achieve this?

Solution

  • Although you already came up with a working solution, you might want to make use of the built-in Flow.first { ... } operator for simplicity.

    suspend fun waitForResult(): State  {
    val resultStates = setOf(State.Success::class, State.Failure::class)
    return state.first { it::class in resultStates }
}