replica-core/me.aartikov.replica.single/ReplicaObserver

ReplicaObserver

Replica observer connects to a replica and receives updates: state and loading error events. Replica observer can be active or inactive (this property is not exposed in the API but is used internally). Only active observer receives updates. Replica observer is associated with some User Interface - a screen or a part of screen.

Functions

cancelObserving

abstract fun cancelObserving()

Cancels observing manually. Typically, the call of this method is not required, because an observer is tied to some coroutine scope.

Properties

loadingErrorFlow

abstract val loadingErrorFlow: Flow<LoadingError>

Flow of loading error events.

stateFlow

abstract val stateFlow: StateFlow<Loadable<T>>

Flow of replica states.

Extensions

currentState

val <T : Any> ReplicaObserver<T>.currentState: Loadable<T>

Returns current replica state.