root

Documentation

Overview

Package root contains root application functions

Index

• func Authenticate(authFn func(string) error) error
• func MainLoop(cmdMap map[string]*CmdConfig, onExit func())
• func NewCommandMap(cfgs ...*CmdConfig) map[string]*CmdConfig
• func ParamsMap(params []string, required []string, optional []string) (dict.Strings, error)
• type CmdConfig
  • func NewCommand(command string, minParams int, docs string, handler CmdHandler) *CmdConfig
  • func NewCommandTask(command string, minParams int, docs string, task cmdTask) *CmdConfig
• type CmdHandler

Functions

func Authenticate

func Authenticate(authFn func(string) error) error

Authenticate performs authentication for the Root account in the command-line app

func MainLoop

func MainLoop(cmdMap map[string]*CmdConfig, onExit func())

MainLoop is the main REPL of the root application

func NewCommandMap

func NewCommandMap(cfgs ...*CmdConfig) map[string]*CmdConfig

NewCommandMap creates a new map of command to CmdConfigs

func ParamsMap

func ParamsMap(params []string, required []string, optional []string) (dict.Strings, error)

ParamsMap gets the key=value map from the parameters list

Types

type CmdConfig

type CmdConfig struct {
	Command   string
	MinParams int
	Docs      string
	Handler   CmdHandler
}

func NewCommand

func NewCommand(command string, minParams int, docs string, handler CmdHandler) *CmdConfig

NewCommand creates a new CmdConfig

func NewCommandTask

func NewCommandTask(command string, minParams int, docs string, task cmdTask) *CmdConfig

NewCommandTask creates a new CmdConfig

type CmdHandler

type CmdHandler = func([]string)

CmdHandler takes in a list of string parameters