wflag

package module

v1.1.0 Latest Latest Go to latest Published: Jun 7, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Wenjunior/wflag

Links

Open Source Insights

README ¶

wflag

wflag is a superset of flag

Instalation

go get github.com/Wenjunior/wflag

Documentation ¶

Index ¶

Variables
func Arg(index int) string
func Args() []string
func Bool(name string, value bool, usage string) *bool
func BoolFunc(name, usage string, function func(string) error)
func BoolVar(pointer *bool, name string, value bool, usage string)
func Duration(name string, value time.Duration, usage string) *time.Duration
func DurationVar(pointer *time.Duration, name string, value time.Duration, usage string)
func Float64(name string, value float64, usage string) *float64
func Float64Var(pointer *float64, name string, value float64, usage string)
func Func(name, usage string, function func(string) error)
func Int(name string, value int, usage string) *int
func Int64(name string, value int64, usage string) *int64
func Int64Var(pointer *int64, name string, value int64, usage string)
func IntVar(pointer *int, name string, value int, usage string)
func NArg() int
func NFlag() int
func Parse()
func Parsed() bool
func PrintDefaults()
func Set(name, value string) error
func String(name string, value string, usage string) *string
func StringSlice(name string, value []string, usage string) *[]string
func StringSliceVar(pointer *[]string, name string, value []string, usage string)
func StringVar(pointer *string, name string, value string, usage string)
func TextVar(pointer encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, ...)
func Uint(name string, value uint, usage string) *uint
func Uint64(name string, value uint64, usage string) *uint64
func Uint64Var(pointer *uint64, name string, value uint64, usage string)
func UintVar(pointer *uint, name string, value uint, usage string)
func UnquoteUsage(flag *Flag) (name string, usage string)
func Var(value Value, name string, usage string)
func Visit(function func(*Flag))
func VisitAll(function func(*Flag))
type ErrorHandling
type Flag
- func Lookup(name string) *Flag
type FlagSet
- func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet
- func (self *FlagSet) Arg(index int) string
- func (self *FlagSet) Args() []string
- func (self *FlagSet) Bool(name string, value bool, usage string) *bool
- func (self *FlagSet) BoolFunc(name, usage string, function func(string) error)
- func (self *FlagSet) BoolVar(pointer *bool, name string, value bool, usage string)
- func (self *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration
- func (self *FlagSet) DurationVar(pointer *time.Duration, name string, value time.Duration, usage string)
- func (self *FlagSet) ErrorHandling() ErrorHandling
- func (self *FlagSet) Float64(name string, value float64, usage string) *float64
- func (self *FlagSet) Float64Var(pointer *float64, name string, value float64, usage string)
- func (self *FlagSet) Func(name, usage string, function func(string) error)
- func (self *FlagSet) Init(name string, errorHandling ErrorHandling)
- func (self *FlagSet) Int(name string, value int, usage string) *int
- func (self *FlagSet) Int64(name string, value int64, usage string) *int64
- func (self *FlagSet) Int64Var(pointer *int64, name string, value int64, usage string)
- func (self *FlagSet) IntVar(pointer *int, name string, value int, usage string)
- func (self *FlagSet) Lookup(name string) *Flag
- func (self *FlagSet) NArg() int
- func (self *FlagSet) NFlag() int
- func (self *FlagSet) Name() string
- func (self *FlagSet) Output() io.Writer
- func (self *FlagSet) Parse(arguments []string) error
- func (self *FlagSet) Parsed() bool
- func (self *FlagSet) PrintDefaults()
- func (self *FlagSet) Set(name, value string) error
- func (self *FlagSet) SetOutput(output io.Writer)
- func (self *FlagSet) String(name string, value string, usage string) *string
- func (self *FlagSet) StringSlice(name string, value []string, usage string) *[]string
- func (self *FlagSet) StringSliceVar(pointer *[]string, name string, value []string, usage string)
- func (self *FlagSet) StringVar(pointer *string, name string, value string, usage string)
- func (self *FlagSet) TextVar(pointer encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, ...)
- func (self *FlagSet) Uint(name string, value uint, usage string) *uint
- func (self *FlagSet) Uint64(name string, value uint64, usage string) *uint64
- func (self *FlagSet) Uint64Var(pointer *uint64, name string, value uint64, usage string)
- func (self *FlagSet) UintVar(pointer *uint, name string, value uint, usage string)
- func (self *FlagSet) Var(value Value, name string, usage string)
- func (self *FlagSet) Visit(function func(*Flag))
- func (self *FlagSet) VisitAll(function func(*Flag))
type Getter
type Value

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrHelp = errors.New("flag: help requested")

View Source

var Usage = func() {
	executableName := getExecutableName()

	fmt.Fprintln(CommandLine.Output(), "Usage: "+executableName+" [options]\n")

	PrintDefaults()
}

Functions ¶

func Arg ¶

func Arg(index int) string

func Args ¶

func Args() []string

func Bool ¶

func Bool(name string, value bool, usage string) *bool

func BoolFunc ¶

func BoolFunc(name, usage string, function func(string) error)

func BoolVar ¶

func BoolVar(pointer *bool, name string, value bool, usage string)

func Duration ¶

func Duration(name string, value time.Duration, usage string) *time.Duration

func DurationVar ¶

func DurationVar(pointer *time.Duration, name string, value time.Duration, usage string)

func Float64 ¶

func Float64(name string, value float64, usage string) *float64

func Float64Var ¶

func Float64Var(pointer *float64, name string, value float64, usage string)

func Func ¶

func Func(name, usage string, function func(string) error)

func Int ¶

func Int(name string, value int, usage string) *int

func Int64 ¶

func Int64(name string, value int64, usage string) *int64

func Int64Var ¶

func Int64Var(pointer *int64, name string, value int64, usage string)

func IntVar ¶

func IntVar(pointer *int, name string, value int, usage string)

func NArg ¶

func NArg() int

func NFlag ¶

func NFlag() int

func Parse ¶

func Parse()

func Parsed ¶

func Parsed() bool

func PrintDefaults ¶

func PrintDefaults()

func Set ¶

func Set(name, value string) error

func String ¶

func String(name string, value string, usage string) *string

func StringSlice ¶ added in v1.1.0

func StringSlice(name string, value []string, usage string) *[]string

func StringSliceVar ¶ added in v1.1.0

func StringSliceVar(pointer *[]string, name string, value []string, usage string)

func StringVar ¶

func StringVar(pointer *string, name string, value string, usage string)

func TextVar ¶

func TextVar(pointer encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, usage string)

func Uint ¶

func Uint(name string, value uint, usage string) *uint

func Uint64 ¶

func Uint64(name string, value uint64, usage string) *uint64

func Uint64Var ¶

func Uint64Var(pointer *uint64, name string, value uint64, usage string)

func UintVar ¶

func UintVar(pointer *uint, name string, value uint, usage string)

func UnquoteUsage ¶

func UnquoteUsage(flag *Flag) (name string, usage string)

func Var ¶

func Var(value Value, name string, usage string)

func Visit ¶

func Visit(function func(*Flag))

func VisitAll ¶

func VisitAll(function func(*Flag))

Types ¶

type ErrorHandling ¶

type ErrorHandling int

const (
	ContinueOnError ErrorHandling = iota
	ExitOnError
	PanicOnError
)

type Flag ¶

type Flag struct {
	Name        string
	Usage       string
	Value       Value
	DefineValue string
}

func Lookup ¶

func Lookup(name string) *Flag

type FlagSet ¶

type FlagSet struct {
	Usage func()
	// contains filtered or unexported fields
}

var CommandLine *FlagSet

func NewFlagSet ¶

func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet

func (*FlagSet) Arg ¶

func (self *FlagSet) Arg(index int) string

func (*FlagSet) Args ¶

func (self *FlagSet) Args() []string

func (*FlagSet) Bool ¶

func (self *FlagSet) Bool(name string, value bool, usage string) *bool

func (*FlagSet) BoolFunc ¶

func (self *FlagSet) BoolFunc(name, usage string, function func(string) error)

func (*FlagSet) BoolVar ¶

func (self *FlagSet) BoolVar(pointer *bool, name string, value bool, usage string)

func (*FlagSet) Duration ¶

func (self *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration

func (*FlagSet) DurationVar ¶

func (self *FlagSet) DurationVar(pointer *time.Duration, name string, value time.Duration, usage string)

func (*FlagSet) ErrorHandling ¶

func (self *FlagSet) ErrorHandling() ErrorHandling

func (*FlagSet) Float64 ¶

func (self *FlagSet) Float64(name string, value float64, usage string) *float64

func (*FlagSet) Float64Var ¶

func (self *FlagSet) Float64Var(pointer *float64, name string, value float64, usage string)

func (*FlagSet) Func ¶

func (self *FlagSet) Func(name, usage string, function func(string) error)

func (*FlagSet) Init ¶

func (self *FlagSet) Init(name string, errorHandling ErrorHandling)

func (*FlagSet) Int ¶

func (self *FlagSet) Int(name string, value int, usage string) *int

func (*FlagSet) Int64 ¶

func (self *FlagSet) Int64(name string, value int64, usage string) *int64

func (*FlagSet) Int64Var ¶

func (self *FlagSet) Int64Var(pointer *int64, name string, value int64, usage string)

func (*FlagSet) IntVar ¶

func (self *FlagSet) IntVar(pointer *int, name string, value int, usage string)

func (*FlagSet) Lookup ¶

func (self *FlagSet) Lookup(name string) *Flag

func (*FlagSet) NArg ¶

func (self *FlagSet) NArg() int

func (*FlagSet) NFlag ¶

func (self *FlagSet) NFlag() int

func (*FlagSet) Name ¶

func (self *FlagSet) Name() string

func (*FlagSet) Output ¶

func (self *FlagSet) Output() io.Writer

func (*FlagSet) Parse ¶

func (self *FlagSet) Parse(arguments []string) error

func (*FlagSet) Parsed ¶

func (self *FlagSet) Parsed() bool

func (*FlagSet) PrintDefaults ¶

func (self *FlagSet) PrintDefaults()

func (*FlagSet) Set ¶

func (self *FlagSet) Set(name, value string) error

func (*FlagSet) SetOutput ¶

func (self *FlagSet) SetOutput(output io.Writer)

func (*FlagSet) String ¶

func (self *FlagSet) String(name string, value string, usage string) *string

func (*FlagSet) StringSlice ¶ added in v1.1.0

func (self *FlagSet) StringSlice(name string, value []string, usage string) *[]string

func (*FlagSet) StringSliceVar ¶ added in v1.1.0

func (self *FlagSet) StringSliceVar(pointer *[]string, name string, value []string, usage string)

func (*FlagSet) StringVar ¶

func (self *FlagSet) StringVar(pointer *string, name string, value string, usage string)

func (*FlagSet) TextVar ¶

func (self *FlagSet) TextVar(pointer encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, usage string)

func (*FlagSet) Uint ¶

func (self *FlagSet) Uint(name string, value uint, usage string) *uint

func (*FlagSet) Uint64 ¶

func (self *FlagSet) Uint64(name string, value uint64, usage string) *uint64

func (*FlagSet) Uint64Var ¶

func (self *FlagSet) Uint64Var(pointer *uint64, name string, value uint64, usage string)

func (*FlagSet) UintVar ¶

func (self *FlagSet) UintVar(pointer *uint, name string, value uint, usage string)

func (*FlagSet) Var ¶

func (self *FlagSet) Var(value Value, name string, usage string)

func (*FlagSet) Visit ¶

func (self *FlagSet) Visit(function func(*Flag))

func (*FlagSet) VisitAll ¶

func (self *FlagSet) VisitAll(function func(*Flag))

type Getter ¶

type Getter interface {
	Value
	Get() any
}

type Value ¶

type Value interface {
	String() string
	Set(string) error
}

Source Files ¶

View all Source files

main.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL