architecture/com.splendo.kaluga.architecture.observable/SharedFlowDefaultSubject

SharedFlowDefaultSubject

open class SharedFlowDefaultSubject<R : T?, T>(defaultValue: R, initialValue: T? = defaultValue, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, sharedFlow: MutableSharedFlow<T?>, autoBind: Boolean = true, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value(initialValue), )) : BaseDefaultSubject<R, T?> , SuspendableSetter<T?>

A BaseDefaultSubject that matches the state of a MutableSharedFlow.

Parameters

the type of value to expect.

defaultValue

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

initialValue

The initial value of T

coroutineScope

The CoroutineScope on which to observe the MutableSharedFlow

context

The CoroutineContext in which to observe the MutableSharedFlow

sharedFlow

The MutableSharedFlow to match the state of.

autoBind

If true this will automatically call bind.

observation

The ObservationInitialized to handle value being observed

Constructors

SharedFlowDefaultSubject

constructor(defaultValue: R, initialValue: T? = defaultValue, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, sharedFlow: MutableSharedFlow<T?>, autoBind: Boolean = true, 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.

liveDataObserver

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

The Observer that observes the observable value.

stateFlow

open override val stateFlow: MutableStateFlow<R>

StateFlow that expresses the content from the observable.

valueDelegate

open override val valueDelegate: ReadWriteProperty<Any?, R>

A ReadOnlyProperty of T

Functions

bind

expect override fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

bind

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

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.

post

open override fun post(newValue: T?)

Updates the value of this Postable

set

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