fsm

Documentation

Index

• Variables
• func NewFSM(opts ...Option) *fsm
• type FSM
• type Option
  • func InitialState(initial string) Option
  • func WrapState(w StateWrapper) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type State
• type StateFunc
• type StateOption
  • func StateDryRun(b bool) StateOption
• type StateOptions
• type StateWrapper

Variables

var (
	ErrInvalidState = errors.New("does not exists")
	StateEnd        = "end"
)

Functions

func NewFSM

func NewFSM(opts ...Option) *fsm

NewFSM creates a new finite state machine having the specified initial state with specified options

Types

type FSM

type FSM interface {
	Start(context.Context, interface{}, ...Option) (interface{}, error)
	Current() string
	Reset()
	State(string, StateFunc)
}

type Option

type Option func(*Options)

Option func signature

func InitialState

func InitialState(initial string) Option

InitialState sets init state for state machine

func WrapState

func WrapState(w StateWrapper) Option

WrapState adds a state Wrapper to a list of options passed into the fsm

type Options

type Options struct {
	// Initial state
	Initial string
	// Wrappers runs before state
	Wrappers []StateWrapper
	// DryRun mode
	DryRun bool
}

Options struct holding fsm options

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions returns new Options struct filled by passed Option

type State

type State interface {
	Name() string
	Body() interface{}
}

type StateFunc

type StateFunc func(ctx context.Context, state State, opts ...StateOption) (State, error)

StateFunc called on state transition and return next step and error

type StateOption

type StateOption func(*StateOptions)

StateOption func signature

func StateDryRun

func StateDryRun(b bool) StateOption

StateDryRun says that state executes in dry run mode

type StateOptions

type StateOptions struct {
	DryRun bool
}

StateOptions holds state options

type StateWrapper

type StateWrapper func(StateFunc) StateFunc

StateWrapper wraps the StateFunc and returns the equivalent