architecture/com.splendo.kaluga.architecture.observable/WithState

WithState

actual interface ~~WithState~~<T>

Deprecated

This feature has been deprecated. It is recommended to use Compose Multiplatform instead.

Interface indicating an observable has a state of T

Type Parameters

T

the type of the state.

expect interface ~~WithState~~<T>

Deprecated

This feature has been deprecated. It is recommended to use Compose Multiplatform instead.

Interface indicating an observable has a state of T

Type Parameters

T

the type of the state.

Inheritors

WithMutableState

actual interface ~~WithState~~<T>

Deprecated

This feature has been deprecated. It is recommended to use Compose Multiplatform instead.

Interface indicating an observable has a state of T

Type Parameters

T

the type of the state.

Properties

open val liveData: LiveData<T>

The LiveData matching stateFlow

actual abstract val stateFlow: StateFlow<T>

StateFlow that expresses the content from the observable.

expect abstract val stateFlow: StateFlow<T>

StateFlow that expresses the content from the observable.

actual abstract val stateFlow: StateFlow<T>

StateFlow that expresses the content from the observable.

actual abstract val valueDelegate: ReadOnlyProperty<Any?, T>

A ReadOnlyProperty of T

expect abstract val valueDelegate: ReadOnlyProperty<Any?, T>

A ReadOnlyProperty of T

actual abstract val valueDelegate: ReadOnlyProperty<Any?, T>

A ReadOnlyProperty of T

Functions

observeNotNullOnLifecycle

fun <T> WithState<T?>.~~observeNotNullOnLifecycle~~(lifecycleOwner: LifecycleOwner, filter: suspend (T) -> Boolean = { true }, onNext: (T) -> Unit): Job

Observes WithState of a nullable value on the lifecycle of a LifecycleOwner

observeOnLifecycle

fun <T> WithState<T>.~~observeOnLifecycle~~(lifecycleOwner: LifecycleOwner, filter: suspend (T) -> Boolean = { true }, onNext: (T) -> Unit): Job

Observes WithState on the lifecycle of a LifecycleOwner

fun <T, R> WithState<T>.~~observeOnLifecycle~~(lifecycleOwner: LifecycleOwner, filter: suspend (T) -> Boolean = { true }, transform: suspend (T) -> R, onNext: (R) -> Unit): Job

Observes WithState on the lifecycle of a LifecycleOwner by transforming the observed value.