lib/app.cash.kfsm

Package-level declarations

Types

data class InvalidStateForTransition(transition: Transition<*, *, *>, val value: Value<*, *, *>) : Exception

interface Invariant<ID, V : Value<ID, V, S>, S : State<ID, V, S>>

Represents an invariant that must hold true for a value in a particular state.

class NoPathToTargetState(val value: Value<*, *, *>, val targetState: State<*, *, *>) : Exception

Exception thrown when a value fails to meet an invariant.

open class State<ID, V : Value<ID, V, S>, S : State<ID, V, S>>(transitionsFn: () -> Set<S>, invariants: List<Invariant<ID, V, S>> = emptyList())

data class States<ID, V : Value<ID, V, S>, S : State<ID, V, S>>(val a: S, val other: Set<S>)

A collection of states that is guaranteed to be non-empty.

open class Transition<ID, V : Value<ID, V, S>, S : State<ID, V, S>>(val from: States<ID, V, S>, val to: S)

abstract class Transitioner<ID, T : Transition<ID, V, S>, V : Value<ID, V, S>, S : State<ID, V, S>>

interface Value<ID, V : Value<ID, V, S>, S : State<ID, V, S>>

Represents a value that can transition between different states in a finite state machine.

fun <ID, V : Value<ID, V, S>, S : State<ID, V, S>> invariant(message: String, predicate: (V) -> Boolean): Invariant<ID, V, S>

Creates an invariant that checks if the given predicate holds true for the value.