View Source Finitomata.State (Finitomata v0.20.1)

Carries the state of the FSM.

Summary

Types

last_error()

The map that holds last error which happened on transition (at given state and event).

payload()

The payload that has been passed to the FSM instance on startup

t()

The internal representation of the FSM state

Functions

excerpt(state, payload? \\ true)

Exposes the short excerpt from state of FSM which is log-friendly

Types

last_error()

@type last_error() ::
  %{
    state: Finitomata.Transition.state(),
    event: Finitomata.Transition.event(),
    error: any()
  }
  | nil

The map that holds last error which happened on transition (at given state and event).

payload()

@type payload() :: any()

The payload that has been passed to the FSM instance on startup

t()

@type t() :: %Finitomata.State{
  name: Finitomata.fsm_name(),
  lifecycle: :loaded | :created | :unknown,
  persistency: nil | module(),
  listener: nil | module(),
  current: Finitomata.Transition.state(),
  payload: payload(),
  timer: non_neg_integer(),
  history: [Finitomata.Transition.state()],
  last_error: last_error()
}

The internal representation of the FSM state

Functions

excerpt(state, payload? \\ true)

Exposes the short excerpt from state of FSM which is log-friendly