flagx

package module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 18, 2023 License: MIT Imports: 11 Imported by: 1

README

flagx

flagx is flag parser with go

Documentation

Index

Constants

View Source 
const (
	ContinueOnError   flag.ErrorHandling = 0b1
	SkipNoDeclared    flag.ErrorHandling = 0b10
	OverrideRedefined flag.ErrorHandling = 0b100
)

Variables

View Source 
var (
	CommandLine = newfgx("", flag.CommandLine)
)

Functions

func Arg 

func Arg(i int) string

func Args 

func Args() []string

func Bool 

func Bool(name string, def bool, opts ...Option) *bool

func BoolList 

func BoolList(name string, def []bool, opts ...Option) *[]bool

func BoolListVar 

func BoolListVar(p *[]bool, name string, def []bool, opts ...Option)

func BoolVar 

func BoolVar(p *bool, name string, def bool, opts ...Option)

func Duration 

func Duration(name string, def time.Duration, opts ...Option) *time.Duration

func DurationList 

func DurationList(name string, def []time.Duration, opts ...Option) *[]time.Duration

func DurationListVar 

func DurationListVar(p *[]time.Duration, name string, def []time.Duration, opts ...Option)

func DurationVar 

func DurationVar(p *time.Duration, name string, def time.Duration, opts ...Option)

func ErrorHandling 

func ErrorHandling() flag.ErrorHandling

func File 

func File(name string, def *os.File, opts ...Option) *os.File

func FileList 

func FileList(name string, def []*os.File, opts ...Option) *[]*os.File

func FileListVar 

func FileListVar(p *[]*os.File, name string, def []*os.File, opts ...Option)

func FileVar 

func FileVar(p *os.File, name string, def *os.File, opts ...Option)

func Float32 

func Float32(name string, def float32, opts ...Option) *float32

func Float32List 

func Float32List(name string, def []float32, opts ...Option) *[]float32

func Float32ListVar 

func Float32ListVar(p *[]float32, name string, def []float32, opts ...Option)

func Float32Var 

func Float32Var(p *float32, name string, def float32, opts ...Option)

func Float64 

func Float64(name string, def float64, opts ...Option) *float64

func Float64List 

func Float64List(name string, def []float64, opts ...Option) *[]float64

func Float64ListVar 

func Float64ListVar(p *[]float64, name string, def []float64, opts ...Option)

func Float64Var 

func Float64Var(p *float64, name string, def float64, opts ...Option)

func Func 

func Func(name string, def func(string) error, opts ...Option) *func(string) error

func FuncVar 

func FuncVar(p *func(string) error, name string, def func(string) error, opts ...Option)

func Int 

func Int(name string, def int, opts ...Option) *int

func Int16 

func Int16(name string, def int16, opts ...Option) *int16

func Int16List 

func Int16List(name string, def []int16, opts ...Option) *[]int16

func Int16ListVar 

func Int16ListVar(p *[]int16, name string, def []int16, opts ...Option)

func Int16Var 

func Int16Var(p *int16, name string, def int16, opts ...Option)

func Int32 

func Int32(name string, def int32, opts ...Option) *int32

func Int32List 

func Int32List(name string, def []int32, opts ...Option) *[]int32

func Int32ListVar 

func Int32ListVar(p *[]int32, name string, def []int32, opts ...Option)

func Int32Var 

func Int32Var(p *int32, name string, def int32, opts ...Option)

func Int64 

func Int64(name string, def int64, opts ...Option) *int64

func Int64List 

func Int64List(name string, def []int64, opts ...Option) *[]int64

func Int64ListVar 

func Int64ListVar(p *[]int64, name string, def []int64, opts ...Option)

func Int64Var 

func Int64Var(p *int64, name string, def int64, opts ...Option)

func Int8 

func Int8(name string, def int8, opts ...Option) *int8

func Int8List 

func Int8List(name string, def []int8, opts ...Option) *[]int8

func Int8ListVar 

func Int8ListVar(p *[]int8, name string, def []int8, opts ...Option)

func Int8Var 

func Int8Var(p *int8, name string, def int8, opts ...Option)

func IntList 

func IntList(name string, def []int, opts ...Option) *[]int

func IntListVar 

func IntListVar(p *[]int, name string, def []int, opts ...Option)

func IntVar 

func IntVar(p *int, name string, def int, opts ...Option)

func Lookup 

func Lookup(name string) *flag.Flag

func MustParse 

func MustParse()

func NArg 

func NArg() int

func NFlag 

func NFlag() int

func Name 

func Name() string

func Output 

func Output() io.Writer

func Parse 

func Parse() error

func Set 

func Set(name, value string)

func SetErrorHandling 

func SetErrorHandling(h flag.ErrorHandling)

func SetOutput 

func SetOutput(w io.Writer)

func String 

func String(name string, def string, opts ...Option) *string

func StringList 

func StringList(name string, def []string, opts ...Option) *[]string

func StringListVar 

func StringListVar(p *[]string, name string, def []string, opts ...Option)

func StringVar 

func StringVar(p *string, name string, def string, opts ...Option)

func Uint 

func Uint(name string, def uint, opts ...Option) *uint

func Uint16 

func Uint16(name string, def uint16, opts ...Option) *uint16

func Uint16List 

func Uint16List(name string, def []uint16, opts ...Option) *[]uint16

func Uint16ListVar 

func Uint16ListVar(p *[]uint16, name string, def []uint16, opts ...Option)

func Uint16Var 

func Uint16Var(p *uint16, name string, def uint16, opts ...Option)

func Uint32 

func Uint32(name string, def uint32, opts ...Option) *uint32

func Uint32List 

func Uint32List(name string, def []uint32, opts ...Option) *[]uint32

func Uint32ListVar 

func Uint32ListVar(p *[]uint32, name string, def []uint32, opts ...Option)

func Uint32Var 

func Uint32Var(p *uint32, name string, def uint32, opts ...Option)

func Uint64 

func Uint64(name string, def uint64, opts ...Option) *uint64

func Uint64List 

func Uint64List(name string, def []uint64, opts ...Option) *[]uint64

func Uint64ListVar 

func Uint64ListVar(p *[]uint64, name string, def []uint64, opts ...Option)

func Uint64Var 

func Uint64Var(p *uint64, name string, def uint64, opts ...Option)

func Uint8 

func Uint8(name string, def uint8, opts ...Option) *uint8

func Uint8List 

func Uint8List(name string, def []uint8, opts ...Option) *[]uint8

func Uint8ListVar 

func Uint8ListVar(p *[]uint8, name string, def []uint8, opts ...Option)

func Uint8Var 

func Uint8Var(p *uint8, name string, def uint8, opts ...Option)

func UintList 

func UintList(name string, def []uint, opts ...Option) *[]uint

func UintListVar 

func UintListVar(p *[]uint, name string, def []uint, opts ...Option)

func UintVar 

func UintVar(p *uint, name string, def uint, opts ...Option)

func Usage 

func Usage()

func Visit 

func Visit(fn func(*Flag))

Types

type Flag 

type Flag struct {
	Lname  string
	Sname  string
	DefVal string
	Value  flag.Value
	Parsed bool
	Usage  string // options
	// contains filtered or unexported fields
}

type Flagx 

type Flagx struct {
	UsageFn func()
	// contains filtered or unexported fields
}

func NewFlagx 

func NewFlagx() *Flagx

func NewNamedFlagx 

func NewNamedFlagx(name, description string) *Flagx

func (*Flagx) Arg 

func (f *Flagx) Arg(i int) string

func (*Flagx) Args 

func (f *Flagx) Args() []string

func (*Flagx) Bool 

func (f *Flagx) Bool(name string, def bool, opts ...Option) *bool

func (*Flagx) BoolList 

func (f *Flagx) BoolList(name string, def []bool, opts ...Option) *[]bool

func (*Flagx) BoolListVar 

func (f *Flagx) BoolListVar(p *[]bool, name string, def []bool, opts ...Option)

func (*Flagx) BoolVar 

func (f *Flagx) BoolVar(p *bool, name string, def bool, opts ...Option)

func (*Flagx) Duration 

func (f *Flagx) Duration(name string, def time.Duration, opts ...Option) *time.Duration

func (*Flagx) DurationList 

func (f *Flagx) DurationList(name string, def []time.Duration, opts ...Option) *[]time.Duration

func (*Flagx) DurationListVar 

func (f *Flagx) DurationListVar(p *[]time.Duration, name string, def []time.Duration, opts ...Option)

func (*Flagx) DurationVar 

func (f *Flagx) DurationVar(p *time.Duration, name string, def time.Duration, opts ...Option)

func (*Flagx) ErrorHandling 

func (f *Flagx) ErrorHandling() flag.ErrorHandling

func (*Flagx) File 

func (f *Flagx) File(name string, def *os.File, opts ...Option) *os.File

func (*Flagx) FileList 

func (f *Flagx) FileList(name string, def []*os.File, opts ...Option) *[]*os.File

func (*Flagx) FileListVar 

func (f *Flagx) FileListVar(p *[]*os.File, name string, def []*os.File, opts ...Option)

func (*Flagx) FileVar 

func (f *Flagx) FileVar(p *os.File, name string, def *os.File, opts ...Option)

func (*Flagx) Float32 

func (f *Flagx) Float32(name string, def float32, opts ...Option) *float32

func (*Flagx) Float32List 

func (f *Flagx) Float32List(name string, def []float32, opts ...Option) *[]float32

func (*Flagx) Float32ListVar 

func (f *Flagx) Float32ListVar(p *[]float32, name string, def []float32, opts ...Option)

func (*Flagx) Float32Var 

func (f *Flagx) Float32Var(p *float32, name string, def float32, opts ...Option)

func (*Flagx) Float64 

func (f *Flagx) Float64(name string, def float64, opts ...Option) *float64

func (*Flagx) Float64List 

func (f *Flagx) Float64List(name string, def []float64, opts ...Option) *[]float64

func (*Flagx) Float64ListVar 

func (f *Flagx) Float64ListVar(p *[]float64, name string, def []float64, opts ...Option)

func (*Flagx) Float64Var 

func (f *Flagx) Float64Var(p *float64, name string, def float64, opts ...Option)

func (*Flagx) Func 

func (f *Flagx) Func(name string, def func(string) error, opts ...Option) *func(string) error

func (*Flagx) FuncVar 

func (f *Flagx) FuncVar(p *func(string) error, name string, def func(string) error, opts ...Option)

func (*Flagx) Int 

func (f *Flagx) Int(name string, def int, opts ...Option) *int

func (*Flagx) Int16 

func (f *Flagx) Int16(name string, def int16, opts ...Option) *int16

func (*Flagx) Int16List 

func (f *Flagx) Int16List(name string, def []int16, opts ...Option) *[]int16

func (*Flagx) Int16ListVar 

func (f *Flagx) Int16ListVar(p *[]int16, name string, def []int16, opts ...Option)

func (*Flagx) Int16Var 

func (f *Flagx) Int16Var(p *int16, name string, def int16, opts ...Option)

func (*Flagx) Int32 

func (f *Flagx) Int32(name string, def int32, opts ...Option) *int32

func (*Flagx) Int32List 

func (f *Flagx) Int32List(name string, def []int32, opts ...Option) *[]int32

func (*Flagx) Int32ListVar 

func (f *Flagx) Int32ListVar(p *[]int32, name string, def []int32, opts ...Option)

func (*Flagx) Int32Var 

func (f *Flagx) Int32Var(p *int32, name string, def int32, opts ...Option)

func (*Flagx) Int64 

func (f *Flagx) Int64(name string, def int64, opts ...Option) *int64

func (*Flagx) Int64List 

func (f *Flagx) Int64List(name string, def []int64, opts ...Option) *[]int64

func (*Flagx) Int64ListVar 

func (f *Flagx) Int64ListVar(p *[]int64, name string, def []int64, opts ...Option)

func (*Flagx) Int64Var 

func (f *Flagx) Int64Var(p *int64, name string, def int64, opts ...Option)

func (*Flagx) Int8 

func (f *Flagx) Int8(name string, def int8, opts ...Option) *int8

func (*Flagx) Int8List 

func (f *Flagx) Int8List(name string, def []int8, opts ...Option) *[]int8

func (*Flagx) Int8ListVar 

func (f *Flagx) Int8ListVar(p *[]int8, name string, def []int8, opts ...Option)

func (*Flagx) Int8Var 

func (f *Flagx) Int8Var(p *int8, name string, def int8, opts ...Option)

func (*Flagx) IntList 

func (f *Flagx) IntList(name string, def []int, opts ...Option) *[]int

func (*Flagx) IntListVar 

func (f *Flagx) IntListVar(p *[]int, name string, def []int, opts ...Option)

func (*Flagx) IntVar 

func (f *Flagx) IntVar(p *int, name string, def int, opts ...Option)

func (*Flagx) Lookup 

func (f *Flagx) Lookup(name string) *flag.Flag

func (*Flagx) MustParse 

func (f *Flagx) MustParse()

func (*Flagx) NArg 

func (f *Flagx) NArg() int

func (*Flagx) NFlag 

func (f *Flagx) NFlag() int

func (*Flagx) Name 

func (f *Flagx) Name() string

func (*Flagx) Output 

func (f *Flagx) Output() io.Writer

func (*Flagx) Parse 

func (f *Flagx) Parse() error

func (*Flagx) Set 

func (f *Flagx) Set(name, value string) error

func (*Flagx) SetErrorHandling 

func (f *Flagx) SetErrorHandling(h flag.ErrorHandling)

func (*Flagx) SetOutput 

func (f *Flagx) SetOutput(w io.Writer)

func (*Flagx) String 

func (f *Flagx) String(name string, def string, opts ...Option) *string

func (*Flagx) StringList 

func (f *Flagx) StringList(name string, def []string, opts ...Option) *[]string

func (*Flagx) StringListVar 

func (f *Flagx) StringListVar(p *[]string, name string, def []string, opts ...Option)

func (*Flagx) StringVar 

func (f *Flagx) StringVar(p *string, name string, def string, opts ...Option)

func (*Flagx) Uint 

func (f *Flagx) Uint(name string, def uint, opts ...Option) *uint

func (*Flagx) Uint16 

func (f *Flagx) Uint16(name string, def uint16, opts ...Option) *uint16

func (*Flagx) Uint16List 

func (f *Flagx) Uint16List(name string, def []uint16, opts ...Option) *[]uint16

func (*Flagx) Uint16ListVar 

func (f *Flagx) Uint16ListVar(p *[]uint16, name string, def []uint16, opts ...Option)

func (*Flagx) Uint16Var 

func (f *Flagx) Uint16Var(p *uint16, name string, def uint16, opts ...Option)

func (*Flagx) Uint32 

func (f *Flagx) Uint32(name string, def uint32, opts ...Option) *uint32

func (*Flagx) Uint32List 

func (f *Flagx) Uint32List(name string, def []uint32, opts ...Option) *[]uint32

func (*Flagx) Uint32ListVar 

func (f *Flagx) Uint32ListVar(p *[]uint32, name string, def []uint32, opts ...Option)

func (*Flagx) Uint32Var 

func (f *Flagx) Uint32Var(p *uint32, name string, def uint32, opts ...Option)

func (*Flagx) Uint64 

func (f *Flagx) Uint64(name string, def uint64, opts ...Option) *uint64

func (*Flagx) Uint64List 

func (f *Flagx) Uint64List(name string, def []uint64, opts ...Option) *[]uint64

func (*Flagx) Uint64ListVar 

func (f *Flagx) Uint64ListVar(p *[]uint64, name string, def []uint64, opts ...Option)

func (*Flagx) Uint64Var 

func (f *Flagx) Uint64Var(p *uint64, name string, def uint64, opts ...Option)

func (*Flagx) Uint8 

func (f *Flagx) Uint8(name string, def uint8, opts ...Option) *uint8

func (*Flagx) Uint8List 

func (f *Flagx) Uint8List(name string, def []uint8, opts ...Option) *[]uint8

func (*Flagx) Uint8ListVar 

func (f *Flagx) Uint8ListVar(p *[]uint8, name string, def []uint8, opts ...Option)

func (*Flagx) Uint8Var 

func (f *Flagx) Uint8Var(p *uint8, name string, def uint8, opts ...Option)

func (*Flagx) UintList 

func (f *Flagx) UintList(name string, def []uint, opts ...Option) *[]uint

func (*Flagx) UintListVar 

func (f *Flagx) UintListVar(p *[]uint, name string, def []uint, opts ...Option)

func (*Flagx) UintVar 

func (f *Flagx) UintVar(p *uint, name string, def uint, opts ...Option)

func (*Flagx) Usage 

func (f *Flagx) Usage()

func (*Flagx) Visit 

func (f *Flagx) Visit(fn func(*Flag))

type Option 

type Option func(*Flag)

func WithDescription 

func WithDescription(desc string) Option

func WithRequire 

func WithRequire(require bool) Option

func WithUnique 

func WithUnique(unique bool) Option

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.