composeextensions/sco.carlukesoftware.composeextensions/State

State

sealed class State<out T>

A generic sealed class that represents the different states of an asynchronous operation or data loading process. It is particularly useful for managing UI state in Jetpack Compose, allowing for exhaustive handling of all possible outcomes.

Type Parameters

The type of data held by the Success state.

Inheritors

Idle

Success

Failure

Types

Failure

data class Failure(val throwable: Throwable) : State<Nothing>

Idle

data object Idle : State<Nothing>

data object Loading : State<Nothing>

Success

data class Success<T>(val data: T) : State<T>

Functions

onFailure

@Composable

fun <T> State<T>.onFailure(block: @Composable (Throwable) -> Unit)

Executes the given composable block if the State is State.Failure. The Throwable associated with the failure is passed to the block.

onIdle

@Composable

fun <T> State<T>.onIdle(block: @Composable () -> Unit)

Executes the given composable block if the State is State.Idle.

onLoading

@Composable

fun <T> State<T>.onLoading(block: @Composable () -> Unit)

Executes the given composable block if the State is State.Loading.

onSuccess

@Composable

fun <T> State<T>.onSuccess(block: @Composable (T) -> Unit)

Executes the given composable block if the State is State.Success. The block will receive the data from the State.Success as its parameter.