architecture/com.splendo.kaluga.architecture.observable/DefaultFlowObservable

DefaultFlowObservable

class DefaultFlowObservable<R : T?, T>(defaultValue: R, initialValue: T? = defaultValue, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, flow: Flow<T?>, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value(initialValue), )) : BaseDefaultObservable<R, T?>

A BaseDefaultObservable that observes the state of a Flow.

Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T

defaultValue

The default value of R to observe if the Flow emits null.

initialValue

The initial value of T

coroutineScope

The CoroutineScope on which to observe the Flow

context

The CoroutineContext in which to observe the Flow

flow

The Flow to observe

observation

The ObservationUninitialized to observe the Flow

Constructors

DefaultFlowObservable

constructor(defaultValue: R, initialValue: T? = defaultValue, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, flow: Flow<T?>, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value(initialValue), ))

Properties

current

open override val current: R

The current value of R

currentOrNull

open override val currentOrNull: T?

The current value T or null being observed

defaultValue

open override val defaultValue: ObservableOptional.Value<R>

The default Value of R. Can be used in case Nothing is Initial.initialValue

initialValue

open override val initialValue: ObservableOptional.Value<T?>

The initial ObservableOptional value of T.

stateFlow

expect open override val stateFlow: StateFlow<R>

StateFlow that expresses the content from the observable.

valueDelegate

expect open override val valueDelegate: ReadOnlyProperty<Any?, R>

A ReadOnlyProperty of T

Functions

getValue

open operator override fun getValue(thisRef: Any?, property: KProperty<*>): ObservableOptional.Value<R>

observe

open override fun observe(onNext: (R?) -> Unit): Disposable

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

observeInitialized

open override fun observeInitialized(onNext: (R) -> 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.

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