arpicee

Documentation

Index

• Variables
• func Equal(expected, is RemoteCall) bool
• func Output(res map[string]interface{}, outputFormat string) (string, error)
• func OutputFormat(args []Argument) string
• func ValidateArguments(args []Argument, params []Parameter) error
• type Argument
  • func ArgsFromFlags(params []Parameter, flags []string) ([]Argument, string, error)
  • func GetArg(args []Argument, name string) Argument
• type ArgumentBool
• type ArgumentInt
• type ArgumentString
• type ParamType
• type Parameter
• type RemoteCall

Variables

var ErrMissingFormatString = errors.New("failed to format response: object missing a formatString")

Functions

func Equal

func Equal(expected, is RemoteCall) bool

func Output

func Output(res map[string]interface{}, outputFormat string) (string, error)

func OutputFormat

func OutputFormat(args []Argument) string

func ValidateArguments

func ValidateArguments(args []Argument, params []Parameter) error

Types

type Argument

type Argument interface {
	// contains filtered or unexported methods
}

func ArgsFromFlags

func ArgsFromFlags(params []Parameter, flags []string) ([]Argument, string, error)

func GetArg

func GetArg(args []Argument, name string) Argument

type ArgumentBool

type ArgumentBool struct {
	Name string
	Val  bool
}

type ArgumentInt

type ArgumentInt struct {
	Name string
	Val  int
}

type ArgumentString

type ArgumentString struct {
	Name string
	Val  string
}

type ParamType

type ParamType int

const (
	TypeBool ParamType = iota
	TypeInt
	TypeString
)

type Parameter

type Parameter struct {
	Name        string
	Type        ParamType
	Description string
	Required    bool
}

type RemoteCall

type RemoteCall interface {
	Name() string
	Description() string
	Params() []Parameter

	Run(args []Argument) (map[string]interface{}, error)
}