mobiuskt-coroutines/kt.mobius.flow

Package-level declarations

Types

DispatcherWorkRunner

class DispatcherWorkRunner(dispatcher: CoroutineDispatcher) : WorkRunner

A WorkRunner that launches work on a CoroutineDispatcher.

ExecutionPolicy

interface ExecutionPolicy

Defines execution behavior of handler functions added to a subtypeEffectHandler.

FlowMobius

object FlowMobius

FlowTransformer

fun interface FlowTransformer<I, O>

SubtypeEffectHandlerBuilder

class SubtypeEffectHandlerBuilder<F : Any, E>(defaultExecutionPolicy: ExecutionPolicy)

UnknownEffectException

data class UnknownEffectException(val effect: Any) : RuntimeException

UnrecoverableIncomingException

class UnrecoverableIncomingException(val cause: Throwable?) : RuntimeException

Used to indicate that an FlowMobiusLoop transformer has received an kotlinx.coroutines.flow.catch call, which is illegal. This exception means Mobius is in an undefined state and should be considered a fatal programmer error.

Functions

asConnectable

fun <I, O> FlowTransformer<I, O>.asConnectable(): Connectable<I, O>

Transforms the FlowTransformer into a Connectable.

flowConnectable

fun <I, O> flowConnectable(transform: FlowTransformer<I, O>): Connectable<I, O>

Constructs a Connectable that applies transform to map a Flow of I into a Flow of O.

flowTransformer

fun <I, O> flowTransformer(transformer: FlowTransformer<I, O>): FlowTransformer<I, O>

fromDispatcher

fun WorkRunners.fromDispatcher(dispatcher: CoroutineDispatcher): WorkRunner

subtypeEffectHandler

fun <F : Any, E> subtypeEffectHandler(block: SubtypeEffectHandlerBuilder<F, E>.() -> Unit): FlowTransformer<F, E>

fun <F : Any, E> subtypeEffectHandler(executionPolicy: ExecutionPolicy, block: SubtypeEffectHandlerBuilder<F, E>.() -> Unit): FlowTransformer<F, E>

toEventSource

fun <E> Flow<E>.toEventSource(scope: CoroutineScope): EventSource<E>

Create an EventSource that emits each E from this Flow.

toFlow

fun <E> EventSource<E>.toFlow(): Flow<E>

Create a Flow that emits each E from this EventSource.

transform

fun <I, O> Flow<I>.transform(connectable: Connectable<I, O>): Flow<O>

Transforms a Flow of I into a Flow of O using the provided Connectable.