appactions

Documentation

Index

• Variables
• func NewAppActionParser[E enum.Value, EP enum.Pntr[E]](val *E) *argparse.Parser
• type Action
• type ActionRegistry
  • func (a ActionRegistry) PerformAction(e enum.Value) error

Variables

var AppRunErr = errors.New("An error occurred running the application")

var AppSetupErr = errors.New("An error occurred setting up the application")

var AppTeardownErr = errors.New("An error occurred tearing down the application")

var UnknownActionErr = errors.New(
	"The supplied enum value has no associated action",
)

Functions

func NewAppActionParser

func NewAppActionParser[E enum.Value, EP enum.Pntr[E]](val *E) *argparse.Parser

Creates a parser that has -a and --action falgs. These flags will be used to set an enum value that should be use to tell your application what action it needs to perform.

Types

type Action

type Action interface {
	Setup() error
	Run() error
	Teardown() error
}

type ActionRegistry

type ActionRegistry map[enum.Value]Action

func (ActionRegistry) PerformAction

func (a ActionRegistry) PerformAction(e enum.Value) error