stages

Documentation

Index

• func Names() (names []string)
• func Register(stage StageCreator)
• type Name
  • func (s *Name) Set(val string) error
  • func (s Name) String() string
• type Stage
• type StageCreator
  • func Get(name string) StageCreator

Functions

func Names

func Names() (names []string)

func Register

func Register(stage StageCreator)

Types

type Name

type Name string

Name is used to identify a StageCreator (which instantiates the stage of the same name) from the command line. It must be in the set of registered stages.

func (*Name) Set

func (s *Name) Set(val string) error

func (Name) String

func (s Name) String() string

type Stage

type Stage interface {
	Run(config types.Config) bool
	Name() string
}

Stage is responsible for actually executing a stage of the configuration.

type StageCreator

type StageCreator interface {
	Create(logger *log.Logger, root string) Stage
	Name() string
}

StageCreator is responsible for instantiating a particular stage given a logger and root path under the root partition.

func Get

func Get(name string) StageCreator