Machinery.Transition (machinery v1.1.0) View Source

Machinery module responsible for control transitions, guard functions and callbacks (before and after). This is meant to be for internal use only.

Link to this section Summary

Functions

after_callbacks(struct, state, module, extra_metadata)

Function responsible to run all after_transitions callbacks or fallback to a boilerplate behaviour. This is meant to be for internal use only.

before_callbacks(struct, state, module, extra_metadata)

Function responsible to run all before_transitions callbacks or fallback to a boilerplate behaviour. This is meant to be for internal use only.

declared_transition?(transitions, current_state, next_state)

Function responsible for checking if the transition from a state to another was specifically declared. This is meant to be for internal use only.

guarded_transition?(module, struct, state, extra_metadata)

Default guard transition fallback to make sure all transitions are permitted unless another existing guard condition exists. This is meant to be for internal use only.

log_transition(struct, state, module, extra_metadata)

Function responsible for triggering transitions persistence. This is meant to be for internal use only.

persist_struct(struct, state, module, extra_metadata)

This function will try to trigger persistence, if declared, to the struct changing state. This is meant to be for internal use only.

Link to this section Functions

after_callbacks(struct, state, module, extra_metadata)

Specs

after_callbacks(struct(), atom(), module(), map()) :: struct()

Function responsible to run all after_transitions callbacks or fallback to a boilerplate behaviour. This is meant to be for internal use only.

before_callbacks(struct, state, module, extra_metadata)

Specs

before_callbacks(struct(), atom(), module(), map()) :: struct()

Function responsible to run all before_transitions callbacks or fallback to a boilerplate behaviour. This is meant to be for internal use only.

declared_transition?(transitions, current_state, next_state)

Specs

declared_transition?(list(), atom(), atom()) :: boolean()

Function responsible for checking if the transition from a state to another was specifically declared. This is meant to be for internal use only.

guarded_transition?(module, struct, state, extra_metadata)

Specs

guarded_transition?(module(), struct(), atom(), map()) :: boolean()

Default guard transition fallback to make sure all transitions are permitted unless another existing guard condition exists. This is meant to be for internal use only.

log_transition(struct, state, module, extra_metadata)

Specs

log_transition(struct(), atom(), module(), map()) :: struct()

Function responsible for triggering transitions persistence. This is meant to be for internal use only.

persist_struct(struct, state, module, extra_metadata)

Specs

persist_struct(struct(), atom(), module(), map()) :: struct()

This function will try to trigger persistence, if declared, to the struct changing state. This is meant to be for internal use only.