clivar

Documentation

Overview

Package clivar provides syntactic sugar for working with the flag package. Allows you to describe using structure tags how to use flag to fill in this structure.

Index

• Constants
• func Load(structData interface{}) error
• func NewTagProcessor() refavour.TagProcessor
• type CliVar
  • func (cli *CliVar) GetBool() *bool
  • func (cli *CliVar) GetFloat64() *float64
  • func (cli *CliVar) GetInt() *int
  • func (cli *CliVar) GetString() *string
• type FieldInfo
• type SliceStrings
• type TagInfo
  • func (tag *TagInfo) GetFieldInfo(typeField reflect.StructField, valueField reflect.Value) (interface{}, error)

Constants

const (
	TagCliExample             = "NAME[description key]:valueType=defaultValue"
	CountPartsTagData         = 2
	CountPartsNameType        = 2
	CountPartsNameDescription = 2
)

const (
	ValueTypeString       = "string"
	ValueTypeInt          = "int"
	ValueTypeFloat64      = "float64"
	ValueTypeBool         = "bool"
	ValueTypeSliceStrings = "SliceStrings"
)

Functions

func Load

func Load(structData interface{}) error

Load field of target struct from flag like described in tags

func NewTagProcessor

func NewTagProcessor() refavour.TagProcessor

Types

type CliVar

type CliVar struct {
	Key          string
	Description  string
	DefaultValue interface{}
}

CliVar describe tag for struct receiver

func (*CliVar) GetBool

func (cli *CliVar) GetBool() *bool

GetBool read bool value from flag

func (*CliVar) GetFloat64

func (cli *CliVar) GetFloat64() *float64

GetFloat64 read float64 value from flag

func (*CliVar) GetInt

func (cli *CliVar) GetInt() *int

GetInt read int value from flag

func (*CliVar) GetString

func (cli *CliVar) GetString() *string

GetString read string value from flag

type FieldInfo

type FieldInfo struct {
	Type         reflect.Type
	Name         string
	ValueType    string
	DefaultValue string
	Description  string
}

type SliceStrings

type SliceStrings []string // separator = ","

type TagInfo

type TagInfo struct {
	Tag string
}

func (*TagInfo) GetFieldInfo

func (tag *TagInfo) GetFieldInfo(typeField reflect.StructField, valueField reflect.Value) (interface{}, error)