Documentation ¶
Index ¶
- type Arguments
- func (arg *Arguments) Add(name string, short string, long string, typ types.ArgTypes, required bool, ...) *Arguments
- func (arg *Arguments) Copyright(year int, author string, email string) *Arguments
- func (arg *Arguments) Count() int
- func (arg *Arguments) Dump() (output []string)
- func (arg *Arguments) ErrorCount() int
- func (arg *Arguments) Errors() (result []string)
- func (arg *Arguments) ExitOnError() *Arguments
- func (arg *Arguments) Get(name string) *descriptor.Descriptor
- func (arg *Arguments) HasErrors() bool
- func (arg *Arguments) Help() (text string)
- func (arg *Arguments) Parse() *Arguments
- func (arg *Arguments) Postscript(line string) *Arguments
- func (arg *Arguments) Preamble(line string) *Arguments
- func (arg *Arguments) ProgramName() *Arguments
- func (arg *Arguments) Reduce() (result parsed.Namespace)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Arguments ¶
type Arguments struct {
// contains filtered or unexported fields
}
Arguments - Top-Level ArgParse struct
func (*Arguments) Add ¶
func (arg *Arguments) Add( name string, short string, long string, typ types.ArgTypes, required bool, argDefault any, help string) *Arguments
Add - append the given Argument object to the list of Arguments.
func (*Arguments) ErrorCount ¶
ErrorCount - return a count of errors
func (*Arguments) ExitOnError ¶
ExitOnError - Exit on any error
func (*Arguments) Get ¶
func (arg *Arguments) Get(name string) *descriptor.Descriptor
Get - append the given Argument object to the list of Arguments.
func (*Arguments) HasErrors ¶
HasErrors - return true if there are any errors in the Arguments struct
func (*Arguments) Postscript ¶
Postscript - Add another line to the postfix set
func (*Arguments) ProgramName ¶
ProgramName - Set the program name from os.Args[0]
Source Files ¶
- Arguments.Add.go
- Arguments.Copyright.go
- Arguments.Count.go
- Arguments.Dump.go
- Arguments.ErrorCount.go
- Arguments.Errors.go
- Arguments.ExitOnError.go
- Arguments.Get.go
- Arguments.HasErrors.go
- Arguments.Help.go
- Arguments.Parse.go
- Arguments.Postscript.go
- Arguments.Preamble.go
- Arguments.ProgramName.go
- Arguments.Reduce.go
- Arguments.Struct.go
- constants.go
Click to show internal directories.
Click to hide internal directories.