fsm

README

FSM

This package contains a simple interface for a finite-state machine in Go.

License

MIT

Documentation

Index

• type BuildState
• type Emitter
• type State
• type StateMachine
• type Store
• type Traverser

Types

type BuildState

type BuildState func(Emitter, Traverser) *State

BuildState is a function that generates a State with access to a specific Emitter and Traverser

type Emitter

type Emitter interface {
	Emit(interface{}) error
}

Emitter is a generic interface to output arbitrary data. Emit is generally called from State.EntryAction.

type State

type State struct {
	Slug        string
	EntryAction func() error
	Transition  func(interface{}) *State
}

State represents an individual state in a larger state machine

type StateMachine

type StateMachine map[string]BuildState

StateMachine is a k:v map that maps the slug of States to BuildState functions

type Store

type Store interface {
	FetchTraverser(uuid string) (Traverser, error)
	CreateTraverser(uuid string) (Traverser, error)
}

A Store is a generic interface responsible for managing The fetching and creation of traversers

type Traverser

type Traverser interface {
	UUID() string
	SetUUID(string)
	CurrentState() string
	SetCurrentState(string)
	Upsert(key string, value interface{}) error
	Fetch(key string) (interface{}, error)
	Delete(key string) error
}

A Traverser is an individual that is traversing the StateMachine. This interface that is responsible for managing the state of that individual