goflag

package module

Go to main page

Versions in this module

v0

v0.1.6

Apr 10, 2024

Changes in this version

type Context

+ func (ctx *Context) AddFlagPtr(flag *Flag) *Flag

type Flag

+ func NewFlag(flagType FlagType, name, shortName string, valuePtr any, usage string, ...) *Flag

type Subcommand

+ func (cmd *Subcommand) AddFlagPtr(flag *Flag) *Subcommand

v0.1.5

Feb 5, 2024

Changes in this version

+ func Choices[T comparable](choices []T) func(v any) (bool, string)

+ func MaxStringLen(length int) func(v any) (bool, string)

+ func Max[T cmp.Ordered](maxValue T) func(v any) (bool, string)

+ func MinStringLen(length int) func(v any) (bool, string)

+ func Min[T cmp.Ordered](minValue T) func(v any) (bool, string)

+ func Range[T cmp.Ordered](minValue, maxValue T) func(v any) (bool, string)

v0.1.4

Feb 5, 2024

v0.1.3

Feb 2, 2024

v0.1.2

Jan 11, 2024

Changes in this version

+ type Subcommand struct

+ Handler func()

+ func (cmd *Subcommand) AddFlag(flagType FlagType, name, shortName string, valuePtr any, usage string, ...) *Subcommand

+ func (cmd *Subcommand) PrintUsage(w io.Writer)

v0.1.1

Jan 11, 2024

v0.1.0

Jan 11, 2024

Changes in this version

+ type Flag struct

+ FlagType FlagType

+ Name string

+ Required bool

+ ShortName string

+ Usage string

+ Validator func(any) (bool, string)

+ Value any

+ func (flag *Flag) Validate(validator func(any) (bool, string)) *Flag

+ type FlagType int

+ const FlagBool

+ const FlagDirPath

+ const FlagDuration

+ const FlagEmail

+ const FlagFilePath

+ const FlagFloat32

+ const FlagFloat64

+ const FlagHostPortPair

+ const FlagIP

+ const FlagInt

+ const FlagInt64

+ const FlagIntSlice

+ const FlagMAC

+ const FlagRune

+ const FlagString

+ const FlagStringSlice

+ const FlagTime

+ const FlagURL

+ const FlagUUID

+ func (i FlagType) String() string

v0.0.4

Jan 2, 2024

v0.0.3

Jan 2, 2024

v0.0.2

Jan 2, 2024

v0.0.1

Oct 2, 2023

Changes in this version

+ func Bool(name, shortName string, value bool, usage string, required ...bool) *gflag

+ func DirPath(name, shortName string, value string, usage string, required ...bool) *gflag

+ func Duration(name, shortName string, value time.Duration, usage string, required ...bool) *gflag

+ func Email(name, shortName string, value string, usage string, required ...bool) *gflag

+ func FilePath(name, shortName string, value string, usage string, required ...bool) *gflag

+ func Float32(name, shortName string, value float32, usage string, required ...bool) *gflag

+ func Float64(name, shortName string, value float64, usage string, required ...bool) *gflag

+ func GenerateCompletions(ctx Getter, cmd Getter)

+ func HostPortPair(name, shortName string, value string, usage string, required ...bool) *gflag

+ func IP(name, shortName string, value net.IP, usage string, required ...bool) *gflag

+ func Int(name, shortName string, value int, usage string, required ...bool) *gflag

+ func Int64(name, shortName string, value int64, usage string, required ...bool) *gflag

+ func IntSlice(name, shortName string, value []int, usage string, required ...bool) *gflag

+ func MAC(name, shortName string, value net.HardwareAddr, usage string, required ...bool) *gflag

+ func ParseBool(value string) (bool, error)

+ func ParseDirPath(value string) (string, error)

+ func ParseDuration(value string) (time.Duration, error)

+ func ParseEmail(value string) (string, error)

+ func ParseFilePath(value string) (string, error)

+ func ParseFloat32(value string) (float32, error)

+ func ParseFloat64(value string) (float64, error)

+ func ParseHostPort(value string) (string, error)

+ func ParseIP(value string) (net.IP, error)

+ func ParseInt(value string) (int, error)

+ func ParseInt64(value string) (int64, error)

+ func ParseIntSlice(value string) ([]int, error)

+ func ParseMAC(value string) (net.HardwareAddr, error)

+ func ParseRune(value string) (rune, error)

+ func ParseStringSlice(value string) ([]string, error)

+ func ParseTime(value string) (time.Time, error)

+ func ParseUUID(value string) (uuid.UUID, error)

+ func ParseUrl(value string) (*url.URL, error)

+ func Rune(name, shortName string, value rune, usage string, required ...bool) *gflag

+ func String(name, shortName string, value string, usage string, required ...bool) *gflag

+ func StringSlice(name, shortName string, value []string, usage string, required ...bool) *gflag

+ func SubCommand(name, description string, handler Handler) *subcommand

+ func Time(name, shortName string, value time.Time, usage string, required ...bool) *gflag

+ func URL(name, shortName string, value *url.URL, usage string, required ...bool) *gflag

+ func UUID(name, shortName string, value uuid.UUID, usage string, required ...bool) *gflag

+ type Context struct

+ func NewContext() *Context

+ func (ctx *Context) AddFlag(flag *gflag) *gflag

+ func (ctx *Context) AddSubCommand(cmd *subcommand) *subcommand

+ func (ctx *Context) GenerateBashCompletions(w io.Writer)

+ func (ctx *Context) GenerateZshCompletions(w io.Writer)

+ func (ctx *Context) Get(name string) any

+ func (ctx *Context) GetBool(name string) bool

+ func (ctx *Context) GetDirPath(name string) string

+ func (ctx *Context) GetDuration(name string) time.Duration

+ func (ctx *Context) GetEmail(name string) string

+ func (ctx *Context) GetFilePath(name string) string

+ func (ctx *Context) GetFloat32(name string) float32

+ func (ctx *Context) GetFloat64(name string) float64

+ func (ctx *Context) GetHostPortPair(name string) string

+ func (ctx *Context) GetIP(name string) net.IP

+ func (ctx *Context) GetInt(name string) int

+ func (ctx *Context) GetInt64(name string) int64

+ func (ctx *Context) GetIntSlice(name string) []int

+ func (ctx *Context) GetMAC(name string) net.HardwareAddr

+ func (ctx *Context) GetRune(name string) rune

+ func (ctx *Context) GetString(name string) string

+ func (ctx *Context) GetStringSlice(name string) []string

+ func (ctx *Context) GetTime(name string) time.Time

+ func (ctx *Context) GetURL(name string) *url.URL

+ func (ctx *Context) GetUUID(name string) uuid.UUID

+ func (ctx *Context) Parse(argv []string) (*subcommand, error)

+ func (ctx *Context) PrintUsage(w io.Writer)

+ type Getter interface

+ Get func(name string) any

+ GetBool func(name string) bool

+ GetDuration func(name string) time.Duration

+ GetFloat32 func(name string) float32

+ GetFloat64 func(name string) float64

+ GetInt func(name string) int

+ GetInt64 func(name string) int64

+ GetIntSlice func(name string) []int

+ GetRune func(name string) rune

+ GetString func(name string) string

+ GetStringSlice func(name string) []string

+ GetTime func(name string) time.Time

+ type Handler func(ctx Getter, cmd Getter)

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