flags

Documentation

Index

• type Array
  • func (f Array) Build(value interface{}) mapper.Mapper
  • func (f Array) FlagAliases() []string
  • func (f Array) FlagName() string
  • func (f Array) FlagUsage() string
  • func (f Array) FlagValueLabel() string
  • func (f Array) Parse(flag *flag.FlagSet) interface{}
• type Bool
  • func (f Bool) Build(value interface{}) mapper.Mapper
  • func (f Bool) FlagAliases() []string
  • func (f Bool) FlagName() string
  • func (f Bool) FlagUsage() string
  • func (f Bool) FlagValueLabel() string
  • func (f Bool) Parse(flag *flag.FlagSet) interface{}
• type Creator
• type Flag
• type Int
  • func (f Int) Build(value interface{}) mapper.Mapper
  • func (f Int) FlagAliases() []string
  • func (f Int) FlagName() string
  • func (f Int) FlagUsage() string
  • func (f Int) FlagValueLabel() string
  • func (f Int) Parse(flag *flag.FlagSet) interface{}
• type Manager
  • func New(l *logger.Logger, flags ...Flag) *Manager
  • func (m *Manager) Add(flag Flag)
  • func (m *Manager) Build(name string, args []string) (map[string]mapper.Mapper, []string, error)
  • func (m *Manager) Help(level int) string
  • func (m *Manager) Size() int
  • func (m *Manager) String() string
• type String
  • func (f String) Build(value interface{}) mapper.Mapper
  • func (f String) FlagAliases() []string
  • func (f String) FlagName() string
  • func (f String) FlagUsage() string
  • func (f String) FlagValueLabel() string
  • func (f String) Parse(flag *flag.FlagSet) interface{}

Types

type Array

type Array struct {
	Name    string
	Aliases []string
	Default []string
	Usage   string
	Action  func(data []string) mapper.Mapper
}

func (Array) Build

func (f Array) Build(value interface{}) mapper.Mapper

func (Array) FlagAliases

func (f Array) FlagAliases() []string

func (Array) FlagName

func (f Array) FlagName() string

func (Array) FlagUsage

func (f Array) FlagUsage() string

func (Array) FlagValueLabel

func (f Array) FlagValueLabel() string

func (Array) Parse

func (f Array) Parse(flag *flag.FlagSet) interface{}

type Bool

type Bool struct {
	Name    string
	Aliases []string
	Default bool
	Usage   string
	Action  func(data bool) mapper.Mapper
}

func (Bool) Build

func (f Bool) Build(value interface{}) mapper.Mapper

func (Bool) FlagAliases

func (f Bool) FlagAliases() []string

func (Bool) FlagName

func (f Bool) FlagName() string

func (Bool) FlagUsage

func (f Bool) FlagUsage() string

func (Bool) FlagValueLabel

func (f Bool) FlagValueLabel() string

func (Bool) Parse

func (f Bool) Parse(flag *flag.FlagSet) interface{}

type Creator

type Creator func(flag Flag)

Creator is action to help plugin to create new flag

type Flag

type Flag interface {
	FlagName() string
	FlagValueLabel() string
	FlagAliases() []string
	FlagUsage() string

	Parse(flag *flag.FlagSet) interface{}
	Build(value interface{}) mapper.Mapper
}

type Int

type Int struct {
	Name    string
	Aliases []string
	Default int64
	Usage   string
	Action  func(data int64) mapper.Mapper
}

func (Int) Build

func (f Int) Build(value interface{}) mapper.Mapper

func (Int) FlagAliases

func (f Int) FlagAliases() []string

func (Int) FlagName

func (f Int) FlagName() string

func (Int) FlagUsage

func (f Int) FlagUsage() string

func (Int) FlagValueLabel

func (f Int) FlagValueLabel() string

func (Int) Parse

func (f Int) Parse(flag *flag.FlagSet) interface{}

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func New

func New(l *logger.Logger, flags ...Flag) *Manager

func (*Manager) Add

func (m *Manager) Add(flag Flag)

func (*Manager) Build

func (m *Manager) Build(name string, args []string) (map[string]mapper.Mapper, []string, error)

func (*Manager) Help

func (m *Manager) Help(level int) string

func (*Manager) Size

func (m *Manager) Size() int

func (*Manager) String

func (m *Manager) String() string

type String

type String struct {
	Name    string
	Aliases []string
	Default string
	Usage   string
	Action  func(data string) mapper.Mapper
}

func (String) Build

func (f String) Build(value interface{}) mapper.Mapper

func (String) FlagAliases

func (f String) FlagAliases() []string

func (String) FlagName

func (f String) FlagName() string

func (String) FlagUsage

func (f String) FlagUsage() string

func (String) FlagValueLabel

func (f String) FlagValueLabel() string

func (String) Parse

func (f String) Parse(flag *flag.FlagSet) interface{}