architecture/com.splendo.kaluga.architecture.observable/InitializedSubject

InitializedSubject

interface InitializedSubject<T> : BasicSubject<T, T, ObservableOptional.Value<T>> , InitializedObservable<T> , MutableInitialized<T, T>

A BasicSubject that is Initialized

Parameters

T

the type of value to expect.

Inheritors

AbstractBaseInitializedSubject

Properties

abstract val current: T

The current value of R

abstract val currentOrNull: T?

The current value T or null being observed

abstract val initialValue: ObservableOptional<T>

The initial ObservableOptional value of T.

liveDataObserver

val <R : T, T, OO : ObservableOptional<R>> BasicSubject<R, T, OO>.liveDataObserver: Observer<T>

The Observer that observes the observable value.

expect abstract val stateFlow: StateFlow<T>

StateFlow that expresses the content from the observable.

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

A ReadOnlyProperty of T

Functions

abstract fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

fun <R : T, T, OO : ObservableOptional<R>> BasicSubject<R, T, OO>.bind(coroutineScope: CoroutineScope)

Convenience method for BasicSubject that calls BasicSubject.bind using the CoroutineContext of the provided CoroutineScope

abstract operator fun getValue(thisRef: Any?, property: KProperty<*>): ObservableOptional.Value<T>

abstract fun observe(onNext: (T?) -> Unit): Disposable

Creates an observation that calls onNext each time a new value is observed until the resulting Disposable is disposed

observeInitialized

abstract fun observeInitialized(onNext: (T) -> Unit): Disposable

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.

abstract fun post(newValue: T)

Updates the value of this Postable

abstract suspend fun set(newValue: T)

Updates the value of this Postable in a suspended manner.

toDefaultObservable

fun <R : T, T> ReadOnlyProperty<Any?, T?>.toDefaultObservable(defaultValue: R): ReadOnlyPropertyDefaultObservable<R, T?>

Converts a ReadOnlyProperty into a ReadOnlyPropertyDefaultObservable

toInitializedObservable

fun <T> ReadOnlyProperty<Any?, T>.toInitializedObservable(): ReadOnlyPropertyInitializedObservable<T>

Converts a ReadOnlyProperty into a ReadOnlyPropertyInitializedObservable