StateMachine.Transition (state_machine v0.1.6)

t(model) :: %StateMachine.Transition{
  after: [StateMachine.Callback.t(model)],
  before: [StateMachine.Callback.t(model)],
  from: atom(),
  guards: [StateMachine.Guard.t(model)],
  to: atom()
}

Link to this section Functions

callback(ctx, pos)

Specs

callback(StateMachine.Context.t(model), callback_pos()) ::
  StateMachine.Context.t(model)

Private function for running Transition callbacks.

finalize(ctx)

Specs

finalize(StateMachine.Context.t(model)) :: StateMachine.Context.t(model)

Private function sets status to :done, unless it has failed before.

is_allowed?(ctx, transition)

Specs

is_allowed?(StateMachine.Context.t(model), t(model)) :: boolean()

Checks if the transition is allowed in the current context. Returns boolean.

loop?(arg1)

Specs

loop?(t(any())) :: boolean()

True if transition is a loop, i.e. doesn't change state.

run(ctx)

Specs

run(StateMachine.Context.t(model)) :: StateMachine.Context.t(model)

Given populated context and Transition structure, sequentially runs all callbacks along with actual state update:

before(event)
before(transition)
before_leave(state)
before_enter(state)
(state update)
after_leave(state)
after_enter(state)
after(transition)
after(event)

If any of the callbacks fails, all sequential ops are cancelled.

update_state(ctx)

Specs

update_state(StateMachine.Context.t(model)) :: StateMachine.Context.t(model)

Private function for updating state.