location/com.splendo.kaluga.location/BaseLocationStateRepo

BaseLocationStateRepo

abstract class BaseLocationStateRepo(createNotInitializedState: () -> LocationState.NotInitialized, createInitializingState: suspend ColdStateFlowRepo<LocationState>.(LocationState.Inactive) -> suspend () -> LocationState.Initializing, createDeinitializingState: suspend ColdStateFlowRepo<LocationState>.(LocationState.Active) -> suspend () -> LocationState.Deinitialized, coroutineContext: CoroutineContext) : ColdStateFlowRepo<LocationState>

An abstract ColdStateFlowRepo for managing LocationState

Parameters

createNotInitializedState

method for creating the initial LocationState.NotInitialized State

createInitializingState

method for transitioning from a LocationState.Inactive into a LocationState.Initializing given an implementation of this ColdStateFlowRepo

createDeinitializingState

method for transitioning from a LocationState.Active into a LocationState.Deinitialized given an implementation of this ColdStateFlowRepo

coroutineContext

the CoroutineContext the CoroutineContext used to create a coroutine scope for this state machine.

Inheritors

LocationStateImplRepo

Constructors

BaseLocationStateRepo

constructor(createNotInitializedState: () -> LocationState.NotInitialized, createInitializingState: suspend ColdStateFlowRepo<LocationState>.(LocationState.Inactive) -> suspend () -> LocationState.Initializing, createDeinitializingState: suspend ColdStateFlowRepo<LocationState>.(LocationState.Active) -> suspend () -> LocationState.Deinitialized, coroutineContext: CoroutineContext)

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

deinitChangeStateWithRepo

val deinitChangeStateWithRepo: suspend (LocationState, ColdStateFlowRepo<LocationState>) -> suspend () -> LocationState?

val firstState: () -> LocationState

initChangeStateWithRepo

val initChangeStateWithRepo: suspend (LocationState, ColdStateFlowRepo<LocationState>) -> suspend () -> LocationState

lazyMutableFlow

open override val lazyMutableFlow: Lazy<MutableStateFlow<LocationState>>

open override val stateFlow: StateFlow<LocationState>

subscriptionCount

val subscriptionCount: StateFlow<Int>

Functions

open suspend override fun collect(collector: FlowCollector<LocationState>): Nothing

firstCollection

open suspend override fun firstCollection()

suspend override fun initialValue(): LocationState

fun Flow<Location>.known(maxAge: Duration = 0.seconds): Flow<Location.KnownLocation?>

Transforms a Flow of LocationState into a flow of its associated optional Location.KnownLocation

laterCollections

open suspend override fun laterCollections(): LocationState

launchTakeAndChangeState

fun launchTakeAndChangeState(context: CoroutineContext, action: suspend (LocationState) -> suspend () -> LocationState): Job

fun <K : LocationState> launchTakeAndChangeState(context: CoroutineContext, remainIfStateNot: KClass<K>, action: suspend (K) -> suspend () -> LocationState): Job

fun <Result> launchUseState(context: CoroutineContext, action: suspend (LocationState) -> Result): Job

fun Flow<LocationState>.location(): Flow<Location>

Transforms a Flow of LocationState into a flow of its associated Location

noMoreCollections

suspend override fun noMoreCollections(): LocationState

fun peekState(): LocationState

takeAndChangeState

suspend fun takeAndChangeState(action: suspend (LocationState) -> suspend () -> LocationState): LocationState

suspend fun <K : LocationState> takeAndChangeState(remainIfStateNot: KClass<K>, action: suspend (K) -> suspend () -> LocationState): LocationState

suspend fun <Result> useState(action: suspend (LocationState) -> Result): Result