orbit-core/org.orbitmvi.orbit

Package-level declarations

Types

interface Container<STATE : Any, SIDE_EFFECT : Any>

The heart of the Orbit MVI system. Represents an MVI container with its input and outputs. You can manipulate the container through the orbit function

ContainerDecorator

interface ContainerDecorator<STATE : Any, SIDE_EFFECT : Any> : Container<STATE, SIDE_EFFECT>

A decorator applying additional logic to a Container.

ContainerHost

interface ContainerHost<STATE : Any, SIDE_EFFECT : Any>

Apply this interface to anything you want to become an orbit container host. Typically this will be an Android ViewModel but it can be applied to simple presenters etc.

RealSettings

data class RealSettings(val sideEffectBufferSize: Int = Channel.BUFFERED, val idlingRegistry: IdlingResource = NoopIdlingResource(), val eventLoopDispatcher: CoroutineDispatcher = Dispatchers.Default, val intentLaunchingDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, val exceptionHandler: CoroutineExceptionHandler? = null, val repeatOnSubscribedStopTimeout: Long = 100)

SettingsBuilder

class SettingsBuilder

Functions

container

fun <STATE : Any, SIDE_EFFECT : Any> CoroutineScope.container(initialState: STATE, buildSettings: SettingsBuilder.() -> Unit = {}, onCreate: suspend SimpleSyntax<STATE, SIDE_EFFECT>.() -> Unit? = null): Container<STATE, SIDE_EFFECT>

Helps create a concrete container in a standard way.

fun Flow<*>.subscribe(onEach: (item: Any) -> Unit, onComplete: () -> Unit, onThrow: (error: Throwable) -> Unit): Job

fun Flow<*>.subscribe(dispatcher: CoroutineDispatcher, onEach: (item: Any) -> Unit, onComplete: () -> Unit, onThrow: (error: Throwable) -> Unit): Job