converter

Documentation

Overview

Package converter Helper to parse and prepare options for go-comic-converter.

It uses goflag with additional feature:

• Keep original order
• Support section

Index

• type Converter
  • func New() *Converter
  • func (c *Converter) AddBoolParam(p *bool, name string, value bool, usage string)
  • func (c *Converter) AddFloatParam(p *float64, name string, value float64, usage string)
  • func (c *Converter) AddIntParam(p *int, name string, value int, usage string)
  • func (c *Converter) AddSection(section string)
  • func (c *Converter) AddStringParam(p *string, name string, value string, usage string)
  • func (c *Converter) Fatal(err error)
  • func (c *Converter) InitParse()
  • func (c *Converter) LoadConfig() error
  • func (c *Converter) Parse()
  • func (c *Converter) Stats()
  • func (c *Converter) Usage(isString bool, f *flag.Flag) string
  • func (c *Converter) Validate() error

Types

type Converter

type Converter struct {
	Options *options.Options
	Cmd     *flag.FlagSet
	// contains filtered or unexported fields
}

func New

func New() *Converter

New Create a new parser

func (*Converter) AddBoolParam

func (c *Converter) AddBoolParam(p *bool, name string, value bool, usage string)

AddBoolParam Add a boolean parameter

func (*Converter) AddFloatParam

func (c *Converter) AddFloatParam(p *float64, name string, value float64, usage string)

AddFloatParam Add an float parameter

func (*Converter) AddIntParam

func (c *Converter) AddIntParam(p *int, name string, value int, usage string)

AddIntParam Add an integer parameter

func (*Converter) AddSection

func (c *Converter) AddSection(section string)

AddSection Create a new section of config

func (*Converter) AddStringParam

func (c *Converter) AddStringParam(p *string, name string, value string, usage string)

AddStringParam Add a string parameter

func (*Converter) Fatal

func (c *Converter) Fatal(err error)

Fatal Helper to show usage, err and exit 1

func (*Converter) InitParse

func (c *Converter) InitParse()

InitParse Initialize the parser with all section and parameter.

func (*Converter) LoadConfig

func (c *Converter) LoadConfig() error

LoadConfig Load default options (config + default)

func (*Converter) Parse

func (c *Converter) Parse()

Parse all parameters

func (*Converter) Stats

func (c *Converter) Stats()

func (*Converter) Usage

func (c *Converter) Usage(isString bool, f *flag.Flag) string

Usage Customize version of FlagSet.PrintDefaults

func (*Converter) Validate

func (c *Converter) Validate() error

Validate Check parameters