StateMachine.State behaviour (state_machine v0.1.6)
State module provides a structure describing a state in the state machine definition. It stores state name along with various callbacks to run before/after leaving/entering a state. Another purpose of the module is to define a behaviour for state get/setters along with the default implementation.
The state get/setters for basic structures and Ecto records are provided out of the box.
Link to this section Summary
Functions
Private function for running state callbacks.
Default implementation of a state getter.
Default implementation of a state setter.
Link to this section Types
Link to this type
callback_pos()
Specs
callback_pos() :: :before_enter | :after_enter | :before_leave | :after_leave
Link to this type
t(model)
Specs
t(model) :: %StateMachine.State{
after_enter: [StateMachine.Callback.t(model)],
after_leave: [StateMachine.Callback.t(model)],
before_enter: [StateMachine.Callback.t(model)],
before_leave: [StateMachine.Callback.t(model)],
name: atom()
}
Link to this section Callbacks
Link to this callback
get(ctx)
Specs
get(ctx :: StateMachine.Context.t(any())) :: atom()
Link to this callback
set(ctx, state)
Specs
set(ctx :: StateMachine.Context.t(model), state :: atom()) :: StateMachine.Context.t(model)
Link to this section Functions
Link to this function
callback(ctx, pos)
Specs
callback(StateMachine.Context.t(model), callback_pos()) :: StateMachine.Context.t(model)
Private function for running state callbacks.
Link to this function
get(ctx)
Specs
get(StateMachine.Context.t(any())) :: atom()
Default implementation of a state getter.
Link to this function
set(ctx, state)
Specs
set(StateMachine.Context.t(model), atom()) :: StateMachine.Context.t(model)
Default implementation of a state setter.