orbit-core/org.orbitmvi.orbit

Package-level declarations

Types

Container

typealias ~~Container<STATE, SIDE_EFFECT>~~ = OrbitContainer<STATE, STATE, SIDE_EFFECT>

An OrbitContainer where the internal state and external state are the same type.

ContainerDecorator

typealias ContainerDecorator<STATE, SIDE_EFFECT> = OrbitContainerDecorator<STATE, STATE, SIDE_EFFECT>

An OrbitContainerDecorator where the internal state and external state are the same type.

ContainerHost

typealias ~~ContainerHost<STATE, SIDE_EFFECT>~~ = OrbitContainerHost<STATE, STATE, SIDE_EFFECT>

An OrbitContainerHost where the internal state and external state are the same type.

ContainerHostWithExternalState

typealias ~~ContainerHostWithExternalState<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>~~ = OrbitContainerHost<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>

An OrbitContainerHost with distinct internal and external state types.

ContainerWithExternalState

typealias ~~ContainerWithExternalState<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>~~ = OrbitContainer<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>

An OrbitContainer with distinct internal and external state types.

Orbit

object Orbit

Global Orbit configuration.

OrbitContainer

interface OrbitContainer<INTERNAL_STATE : Any, EXTERNAL_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

OrbitContainerDecorator

interface OrbitContainerDecorator<INTERNAL_STATE : Any, EXTERNAL_STATE : Any, SIDE_EFFECT : Any> : OrbitContainer<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>

A decorator applying additional logic to an OrbitContainer.

OrbitContainerHost

interface OrbitContainerHost<INTERNAL_STATE : Any, EXTERNAL_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, val sideEffectMode: SideEffectMode = SideEffectMode.FAN_OUT, val sideEffectReplayClearDelayMs: Long = 100)

SettingsBuilder

class SettingsBuilder

SideEffectMode

enum SideEffectMode : Enum<SideEffectMode>

Controls how side effects are delivered to collectors.

Functions

blockingIntent

fun <INTERNAL_STATE : Any, EXTERNAL_STATE : Any, SIDE_EFFECT : Any> OrbitContainerHost<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>.blockingIntent(registerIdling: Boolean = true, transformer: suspend Syntax<INTERNAL_STATE, SIDE_EFFECT>.() -> Unit)

Build and execute an intent on OrbitContainer in a blocking manner, without dispatching.

container

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

Helps create a concrete container in a standard way.

fun <INTERNAL_STATE : Any, EXTERNAL_STATE : Any, SIDE_EFFECT : Any> CoroutineScope.~~container~~(initialState: INTERNAL_STATE, transformState: (INTERNAL_STATE) -> EXTERNAL_STATE, buildSettings: SettingsBuilder.() -> Unit = {}, onCreate: suspend Syntax<INTERNAL_STATE, SIDE_EFFECT>.() -> Unit? = null): OrbitContainer<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>

Helps create a concrete container with external state transformation in a standard way.

orbitContainer

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

Helps create a concrete container in a standard way.

fun <INTERNAL_STATE : Any, EXTERNAL_STATE : Any, SIDE_EFFECT : Any> CoroutineScope.orbitContainer(initialState: INTERNAL_STATE, transformState: (INTERNAL_STATE) -> EXTERNAL_STATE, buildSettings: SettingsBuilder.() -> Unit = {}, onCreate: suspend Syntax<INTERNAL_STATE, SIDE_EFFECT>.() -> Unit? = null): OrbitContainer<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>

Helps create a concrete container with external state transformation in a standard way.

withExternalState

fun <INTERNAL_STATE : Any, EXTERNAL_STATE : Any, SIDE_EFFECT : Any> OrbitContainer<INTERNAL_STATE, INTERNAL_STATE, SIDE_EFFECT>.~~withExternalState~~(transformState: (INTERNAL_STATE) -> EXTERNAL_STATE): OrbitContainer<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT>

Wraps an OrbitContainer with an external state transformation.