params

package

v1.7.17 Latest Latest Go to latest Published: Jul 4, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Details

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

Repository

github.com/vdaas/vald

Links

Documentation ¶

Overview ¶

Package params provides implementation of Go API for argument parser

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Data ¶

type Data interface {
	ConfigFilePath() string
	ShowVersion() bool
}

Data is an interface to get the configuration path and flag.

type ErrorHandling ¶ added in v1.7.17

type ErrorHandling = flag.ErrorHandling

const (
	ContinueOnError ErrorHandling = flag.ContinueOnError
	PanicOnError    ErrorHandling = flag.PanicOnError
	ExitOnError     ErrorHandling = flag.ExitOnError
)

type Option ¶

type Option func(*parser)

func WithArgumentFilters ¶ added in v1.7.17

func WithArgumentFilters(filters ...func(string) bool) Option

WithArgumentFilters returns Option that sets filters. filters is a slice of functions that takes a string and returns a bool. If the string not matched all filters (means filter returns false), it will be added to the arguments.

func WithConfigFileDescription ¶

func WithConfigFileDescription(desc string) Option

WithConfigFileDescription returns Option that sets filePath.description.

func WithConfigFilePathDefault ¶

func WithConfigFilePathDefault(path string) Option

WithConfigFilePathDefault returns Option that sets filePath.defaultPath.

func WithConfigFilePathKeys ¶

func WithConfigFilePathKeys(keys ...string) Option

WithConfigFilePathKeys returns Option that sets filePath.keys.

func WithName ¶ added in v1.7.17

func WithName(name string) Option

WithName returns Option that sets name.

func WithOverrideDefault ¶ added in v1.7.17

func WithOverrideDefault(flag bool) Option

WithOverrideDefault returns Option that overrides default flag.CommandLine.

func WithVersionDescription ¶

func WithVersionDescription(desc string) Option

WithVersionDescription returns Option that sets version.description.

func WithVersionFlagDefault ¶

func WithVersionFlagDefault(flag bool) Option

WithVersionFlagDefault returns Option that sets version.defaultFlag.

func WithVersionKeys ¶

func WithVersionKeys(keys ...string) Option

WithVersionKeys returns Option that sets version.keys.

type Parser ¶ added in v1.7.0

type Parser interface {
	Parse() (Data, bool, error)
}

Parser is an interface to parse commnad-line argument.

func New ¶

func New(opts ...Option) Parser

New returns parser object.

Source Files ¶

View all Source files

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