architecture/com.splendo.kaluga.architecture.observable/FlowObservable

FlowObservable

class FlowObservable<T>(val coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, val flow: Flow<T>, observation: ObservationUninitialized<T> = ObservationUninitialized()) : BaseUninitializedObservable<T>

A BaseUninitializedObservable that observes the state of a Flow

Parameters

the type of value to expect.

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

FlowObservable

constructor(coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, flow: Flow<T>, observation: ObservationUninitialized<T> = ObservationUninitialized())

Properties

coroutineScope

val coroutineScope: CoroutineScope

currentOrNull

open override val currentOrNull: T?

The current value T or null being observed

flow

val flow: Flow<T>

initialValue

open override val initialValue: ObservableOptional.Nothing<T>

The initial ObservableOptional value of T.

stateFlow

expect open override val stateFlow: StateFlow<T?>

StateFlow that expresses the content from the observable.

valueDelegate

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

A ReadOnlyProperty of T

Functions

getValue

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

observe

open override 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

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