options

package
v12.130.0 Latest Latest
Warning

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

 Go to latest Published: Jul 5, 2024 License: Apache-2.0 Imports: 5 Imported by: 20

Documentation

Overview

Package options provides methods for working with command-line options

Index

Examples

Constants

View Source 
const (
	STRING uint8 = iota // String option
	INT                 // Int/Uint option
	BOOL                // Boolean option
	FLOAT               // Floating number option
	MIXED               // String or boolean option
)

Options types

View Source 
const (
	ERROR_UNSUPPORTED = iota
	ERROR_DUPLICATE_LONGNAME
	ERROR_DUPLICATE_SHORTNAME
	ERROR_OPTION_IS_NIL
	ERROR_EMPTY_VALUE
	ERROR_WRONG_FORMAT
	ERROR_CONFLICT
	ERROR_BOUND_NOT_SET
	ERROR_UNSUPPORTED_VALUE
	ERROR_UNSUPPORTED_ALIAS_LIST_FORMAT
	ERROR_UNSUPPORTED_CONFLICT_LIST_FORMAT
	ERROR_UNSUPPORTED_BOUND_LIST_FORMAT
)

Error codes

Variables

View Source 
var (
	// ErrNilOptions returns if options struct is nil
	ErrNilOptions = fmt.Errorf("Options struct is nil")

	// ErrNilMap returns if options map is nil
	ErrNilMap = fmt.Errorf("Options map is nil")

	// ErrEmptyName returns if option have no name
	ErrEmptyName = fmt.Errorf("One or more options do not have a name")
)
View Source 
var MergeSymbol = " "

MergeSymbol used for joining several mergeble options with string value

Functions

func Add 

func Add(name string, opt *V) error

Add adds new supported option

Example 
Output:

func Delete added in v12.127.0 

func Delete(name string) bool

Delete deletes option with given name

You can use this method to remove options with private data such as passwords, tokens, etc.

Example 
Output:

func F added in v12.108.0 

func F(opt string) string

F formats option name (shortcut for Format)

func Format added in v12.94.0 

func Format(opt string) string

Format formats option name

Example 
Output:

Option: -t/--test

func GetB 

func GetB(name string) bool

GetB returns option value as boolean

Example 
Output:

func GetF 

func GetF(name string) float64

GetF returns option value as floating number

Example 
Output:

func GetI 

func GetI(name string) int

GetI returns option value as integer

Example 
Output:

func GetS 

func GetS(name string) string

GetS returns option value as string

Example 
Output:

func Has 

func Has(name string) bool

Has checks if option with given name exists and set

Example 
Output:

func Is added in v12.47.0 

func Is(name string, value any) bool

Is checks if option with given name has given value

Example 
Output:

func Merge added in v12.94.0 

func Merge(opts ...string) string

Merge merges several options into string

func Parse 

func Parse(optMap ...Map) (Arguments, Errors)

Parse parses slice with raw options

Example 
Output:

func ParseOptionName 

func ParseOptionName(opt string) (string, string)

ParseOptionName parses combined name and returns long and short options

func Q 

func Q(opts ...string) string

Q merges several options into string (shortcut for Merge)

func Split added in v12.77.0 

func Split(name string) []string

Split splits mergeble option to it's values

Example 
Output:

Types

type Argument added in v12.45.0 

type Argument string

Argument is command argument

func (Argument) Base added in v12.45.0 

func (a Argument) Base() Argument

Base is shorthand analog of path.Base

Example 
Output:

Arguments: [run /srv/app//conf/myapp.conf]
Clean: /srv/app/conf/myapp.conf
Base: myapp.conf
Dir: /srv/app/conf
Ext: .conf
IsAbs: true

func (Argument) Bool added in v12.45.0 

func (a Argument) Bool() (bool, error)

Int converts argument to int

Example 
Output:

Arguments: [release yes]
Force: true

func (Argument) Clean added in v12.45.0 

func (a Argument) Clean() Argument

Clean is shorthand analog of path.Clean

Example 
Output:

Arguments: [run /srv/app//conf/myapp.conf]
Clean: /srv/app/conf/myapp.conf
Base: myapp.conf
Dir: /srv/app/conf
Ext: .conf
IsAbs: true

func (Argument) Dir added in v12.45.0 

func (a Argument) Dir() Argument

Dir is shorthand analog of path.Dir

Example 
Output:

Arguments: [run /srv/app//conf/myapp.conf]
Clean: /srv/app/conf/myapp.conf
Base: myapp.conf
Dir: /srv/app/conf
Ext: .conf
IsAbs: true

func (Argument) Ext added in v12.45.0 

func (a Argument) Ext() Argument

Ext is shorthand analog of path.Ext

Example 
Output:

Arguments: [run /srv/app//conf/myapp.conf]
Clean: /srv/app/conf/myapp.conf
Base: myapp.conf
Dir: /srv/app/conf
Ext: .conf
IsAbs: true

func (Argument) Float added in v12.45.0 

func (a Argument) Float() (float64, error)

Int converts argument to int

Example 
Output:

Arguments: [ratio 2.37]
Ratio: 2.37

func (Argument) Int added in v12.45.0 

func (a Argument) Int() (int, error)

Int converts argument to int

Example 
Output:

Arguments: [head file.txt 10]
Lines: 10

func (Argument) Int64 added in v12.45.0 

func (a Argument) Int64() (int64, error)

Int64 converts argument to int64

Example 
Output:

Arguments: [head file.txt 10]
Lines: 10

func (Argument) Is added in v12.49.0 

func (a Argument) Is(value any) bool

Is returns true if argument equals to given value

Example 
Output:

Arguments: [parse fileA.txt fileB.jpg fileC.txt]
Command is "parse": true
Command is "clear": false

func (Argument) IsAbs added in v12.45.0 

func (a Argument) IsAbs() bool

IsAbs is shorthand analog of path.IsAbs

Example 
Output:

Arguments: [run /srv/app//conf/myapp.conf]
Clean: /srv/app/conf/myapp.conf
Base: myapp.conf
Dir: /srv/app/conf
Ext: .conf
IsAbs: true

func (Argument) Match added in v12.45.0 

func (a Argument) Match(pattern string) (bool, error)

Match is shorthand analog of path.Match

Example 
Output:

Arguments: [parse fileA.txt fileB.jpg]
fileA.txt is match: true
fileB.jpg is match: false

func (Argument) String added in v12.45.0 

func (a Argument) String() string

String converts argument to string

Example 
Output:

Arguments: [head file.txt 10]
Command: head

func (Argument) ToLower added in v12.45.0 

func (a Argument) ToLower() Argument

ToLower returns argument converted to lower case

Example 
Output:

Arguments: [add-user John]
User: john

func (Argument) ToUpper added in v12.45.0 

func (a Argument) ToUpper() Argument

ToUpper returns argument converted to upper case

Example 
Output:

Arguments: [add-user John]
User: JOHN

func (Argument) Uint added in v12.45.0 

func (a Argument) Uint() (uint64, error)

Uint converts argument to uint

Example 
Output:

Arguments: [head file.txt 10]
Lines: 10

type Arguments 

type Arguments []Argument

Arguments is a slice with with command argument

func NewArguments added in v12.45.0 

func NewArguments(args ...string) Arguments

NewArguments creates new arguments slice from given strings

Example 
Output:

Arguments: [head file.txt 10]
Command: head
File: file.txt
Lines: 10

func (Arguments) Append added in v12.45.0 

func (a Arguments) Append(args ...string) Arguments

Append adds arguments to the end of the arguments slices

Example 
Output:

Arguments: [head file.txt 10]

func (Arguments) Filter added in v12.45.0 

func (a Arguments) Filter(pattern string) Arguments

Filter filters arguments by a given glob pattern. This method works only with files. It means that for a given path only the last part will be checked for pattern matching.

Example 
Output:

Arguments: [parse fileA.txt fileB.jpg fileC.txt]
Text files: [fileA.txt fileC.txt]

func (Arguments) Flatten added in v12.66.0 

func (a Arguments) Flatten() string

Flatten converts arguments to the string (useful for custom parsing logic)

Example 
Output:

Arguments: head file.txt 10

func (Arguments) Get 

func (a Arguments) Get(index int) Argument

Get returns argument with given index

Example 
Output:

Arguments: [head file.txt 10]
Command: head
File: file.txt
Lines: 10

func (Arguments) Has 

func (a Arguments) Has(index int) bool

Has returns true if arguments contains argument with given index

Example 
Output:

Arguments: [head file.txt 10]
Has command: true

func (Arguments) Last added in v12.45.0 

func (a Arguments) Last() Argument

Get returns the last argument

Example 
Output:

Arguments: [head file.txt 10]
Last argument: 10

func (Arguments) Strings added in v12.45.0 

func (a Arguments) Strings() []string

Strings converts arguments to slice with strings

Example 
Output:

Arguments: [head file.txt 10]

func (Arguments) Unshift added in v12.45.0 

func (a Arguments) Unshift(args ...string) Arguments

Unshift adds arguments to the beginning of the arguments slices

Example 
Output:

Arguments: [head file.txt 10]

type Errors added in v12.117.0 

type Errors []error

Errors is a slice with errors

func AddMap 

func AddMap(optMap Map) Errors

AddMap adds map with supported options

Example 
Output:

func (Errors) IsEmpty added in v12.117.0 

func (e Errors) IsEmpty() bool

IsEmpty returns true if errors slice is empty

func (Errors) String added in v12.117.0 

func (e Errors) String() string

String returns string representation of error slice

type Map 

type Map map[string]*V

Map is map with list of options

func (Map) Delete added in v12.108.0 

func (m Map) Delete(name string) bool

Delete removes option from map

Example 
Output:

Option -t/--test deleted

func (Map) Set added in v12.108.0 

func (m Map) Set(name string, opt *V) error

Set set option in map Note that if the option is already set, it will be replaced

Example 
Output:

func (Map) String added in v12.111.0 

func (m Map) String() string

String returns string representation of options map

Example 
Output:

options.Map[size:Int{Value:25 Min:10 Max:1000 Alias:[--items --objects] Conflicts:-E/--empty Bound:-c/--create}]

type OptionError 

type OptionError struct {
	Option      string
	BoundOption string
	Type        int
}

OptionError is argument parsing error

func (OptionError) Error 

func (e OptionError) Error() string

type Options 

type Options struct {
	// contains filtered or unexported fields
}

Options is options struct

func NewOptions 

func NewOptions() *Options

NewOptions creates new options struct

Example 
Output:

Arguments: [file.txt]
User: bob
Lines: 12

func (*Options) Add 

func (o *Options) Add(name string, option *V) error

Add adds a new option

Example 
Output:

Arguments: [file.txt]
User: bob
Lines: 12

func (*Options) AddMap 

func (o *Options) AddMap(optMap Map) Errors

AddMap adds map with supported options

Example 
Output:

Arguments: [file.txt]
User: bob
Lines: 12

func (*Options) Delete added in v12.127.0 

func (o *Options) Delete(name string) bool

Delete deletes option with given name

You can use this method to remove options with private data such as passwords, tokens, etc.

Example 
Output:

Arguments: [file.txt]
Has user option: true
Has lines option: false
Has password option: false

func (*Options) GetB 

func (o *Options) GetB(name string) bool

GetB returns option value as boolean

Example 
Output:

Arguments: [file.txt]
User: bob
Force: true

func (*Options) GetF 

func (o *Options) GetF(name string) float64

GetF returns option value as floating number

Example 
Output:

Arguments: [file.txt]
User: bob
Ratio: 2.35

func (*Options) GetI 

func (o *Options) GetI(name string) int

GetI returns option value as integer

Example 
Output:

Arguments: [file.txt]
User: bob
Lines: 12

func (*Options) GetS 

func (o *Options) GetS(name string) string

GetS returns option value as string

Example 
Output:

Arguments: [file.txt]
User: bob
Lines: 12

func (*Options) Has 

func (o *Options) Has(name string) bool

Has checks if option with given name exists and set

Example 
Output:

Arguments: [file.txt]
Has user option: true
Has lines option: false

func (*Options) Is added in v12.47.0 

func (o *Options) Is(name string, value any) bool

Is checks if option with given name has given value

func (*Options) Parse 

func (o *Options) Parse(rawOpts []string, optMap ...Map) (Arguments, Errors)

Parse parses slice with raw options

Example 
Output:

Arguments: [file.txt]
User: bob
Lines: 12

func (*Options) Split added in v12.77.0 

func (o *Options) Split(name string) []string

Split splits mergeble option to it's values

Example 
Output:

Arguments: [file.txt]
Users: [bob john dave]
Ratio: 3.14

type V 

type V struct {
	Type      uint8   // option type
	Max       float64 // maximum integer option value
	Min       float64 // minimum integer option value
	Alias     any     // string or slice of strings with aliases
	Conflicts any     // string or slice of strings with conflicts options
	Bound     any     // string or slice of strings with bound options
	Mergeble  bool    // option supports options value merging

	Value any // default value
	// contains filtered or unexported fields
}

V is basic option struct

func (*V) String added in v12.111.0 

func (v *V) String() string

String returns string representation of option

Example 
Output:

Int{Value:25 Min:10 Max:1000 Alias:--items Conflicts:-E/--empty Bound:-c/--create}

Source Files

View all Source files

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.