ecto_fsm

v0.2.0

ecto_fsm v0.2.0 Ecto.FSM.Machine View Source

Provides functions for using FSMs.

Link to this section Summary

Types

meta_event_error()
meta_event_reply()

Functions

action_available?(state, action)

Returns true if given action is available

available_actions(state)

Returns available actions

event(state, arg)

Meta application of the transition function, using find_handler/2 to find the module implementing it

event_bypasses(state)

Returns global bypasses

find_bypass_handler(state, trans)

Find bypass

find_handler(arg)

Returns handler for given action, if any

find_info(state, trans)

Returns info for particular transition

fsm(state)

Returns Ecto.FSM.specs() built from all handlers

infos(state, action)

Returns global doc

Link to this section Types

Link to this type

meta_event_error() View Source 
meta_event_error() :: :illegal_action | term()

Link to this type

meta_event_reply() View Source 
meta_event_reply() ::
  {:ok, Ecto.FSM.Machine.State.t()} | {:error, meta_event_error()}

Link to this section Functions

Link to this function

action_available?(state, action) View Source 
action_available?(Ecto.FSM.Machine.State.t(), Ecto.FSM.trans()) :: boolean()

Returns true if given action is available

Link to this function

available_actions(state) View Source 
available_actions(Ecto.FSM.Machine.State.t()) :: [Ecto.FSM.trans()]

Returns available actions

Link to this function

event(state, arg) View Source 
event(Ecto.FSM.Machine.State.t(), {Ecto.FSM.trans(), term()}) ::
  meta_event_reply()

Meta application of the transition function, using find_handler/2 to find the module implementing it.

Link to this function

event_bypasses(state) View Source 
event_bypasses(Ecto.FSM.Machine.State.t()) :: Ecto.FSM.bypasses()

Returns global bypasses

Link to this function

find_bypass_handler(state, trans) View Source 
find_bypass_handler(Ecto.FSM.Machine.State.t(), Ecto.FSM.trans()) ::
  Ecto.FSM.handler() | nil

Find bypass

Link to this function

find_handler(arg) View Source 
find_handler({Ecto.FSM.Machine.State.t(), Ecto.FSM.trans()}) ::
  Ecto.FSM.handler() | nil

Returns handler for given action, if any

Link to this function

find_info(state, trans) View Source 
find_info(Ecto.FSM.state(), Ecto.FSM.trans()) :: Ecto.FSM.info() | nil

Returns info for particular transition

Link to this function

fsm(state) View Source 
fsm(Ecto.FSM.Machine.State.t()) :: Ecto.FSM.specs()

Returns Ecto.FSM.specs() built from all handlers

Link to this function

infos(state, action) View Source 
infos(Ecto.FSM.Machine.State.t(), Ecto.FSM.trans()) :: Ecto.FSM.docs()

Returns global doc