options

package

v0.0.0-...-553a8f7 Latest Latest Go to latest Published: Oct 16, 2019 License: Unlicense Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/toy80/utils

Documentation ¶

Index ¶

Constants
func MarshalMapValue(m reflect.Value, sep1, sep2 string) (s string, err error)
func MarshalSliceValue(slice reflect.Value, sep string) (s string, err error)
func UnmarshalMap(src, sep1, sep2 string, ptrToMap interface{}) (err error)
func UnmarshalSlice(src, sep string, ptrToSlice interface{}) (err error)
type Option
type Options
- func Reflect(o interface{}) (opts Options, err error)
type Tags

Constants ¶

View Source

const Separator = '.'

Variables ¶

This section is empty.

Functions ¶

func MarshalMapValue ¶

func MarshalMapValue(m reflect.Value, sep1, sep2 string) (s string, err error)

func MarshalSliceValue ¶

func MarshalSliceValue(slice reflect.Value, sep string) (s string, err error)

func UnmarshalMap ¶

func UnmarshalMap(src, sep1, sep2 string, ptrToMap interface{}) (err error)

func UnmarshalSlice ¶

func UnmarshalSlice(src, sep string, ptrToSlice interface{}) (err error)

Types ¶

type Option ¶

type Option struct {
	Tags
	Name     string
	Var      reflect.Value
	DefValue string
}

func (Option) Apply ¶

func (opt Option) Apply(val *string) (err error)

func (Option) Help ¶

func (opt Option) Help() string

func (Option) String ¶

func (opt Option) String() string

func (Option) ValueString ¶

func (opt Option) ValueString() string

func (Option) ValueType ¶

func (opt Option) ValueType() string

type Options ¶

type Options []Option

Options is always sorted

func Reflect ¶

func Reflect(o interface{}) (opts Options, err error)

Reflect structure/map

func (Options) Apply ¶

func (opts Options) Apply(args []string, handleNotFound func(a string) bool) (natuals []string, err error)

Apply args into opts

func (Options) ApplyLoose ¶

func (opts Options) ApplyLoose(args []string) (natuals []string, err error)

func (Options) ApplyStrict ¶

func (opts Options) ApplyStrict(args []string) (natuals []string, err error)

func (Options) Filter ¶

func (opts Options) Filter(f func(Option) bool) Options

func (Options) Get ¶

func (opts Options) Get(name string) *Option

func (Options) Help ¶

func (opts Options) Help() string

func (Options) PrintHelp ¶

func (opts Options) PrintHelp(w io.Writer)

func (*Options) Reflect ¶

func (opts *Options) Reflect(o interface{}, name string, tags *Tags) (err error)

func (*Options) ReflectValue ¶

func (opts *Options) ReflectValue(v reflect.Value, name string, tags Tags) (err error)

func (Options) String ¶

func (opts Options) String() string

type Tags ¶

type Tags struct {
	Override  string
	Default   string // default value
	Usage     string
	Sensitive bool
	Inline    bool
	CfgFile   bool // -config=/etc/my.cfg
	Multi     bool // -load a -load b -load c

	AsString   bool
	Sep1, Sep2 string
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
arguments Package arguments parse -key=value style command line arguments for package github.com/toy80/utils/options	Package arguments parse -key=value style command line arguments for package github.com/toy80/utils/options

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