flags

package

v0.0.0-...-b1e9806 Latest Latest Go to latest Published: May 14, 2024 License: Apache-2.0 Imports: 9 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/fidelity/kconnect

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BindFlags(cmd *cobra.Command)
func ConvertToMap(fs *pflag.FlagSet) map[string]string
func CopyFlagValue(sourceFlagName, destinationFlagName string, fs *pflag.FlagSet, ...) error
func CreateCommandFlags(cmd *cobra.Command, cs config.ConfigurationSet) error
func CreateFlagsFromConfig(cs config.ConfigurationSet) (*pflag.FlagSet, error)
func ExistsWithValue(name string, flags *pflag.FlagSet) bool
func GetFlagValueDirect(args []string, longName, shortName string) (string, error)
func ParseFlagMultiValueToMap(flag string) map[string]string
func PopulateConfigFromCommand(cmd *cobra.Command, cs config.ConfigurationSet)
func PopulateConfigFromFlags(flags *pflag.FlagSet, cs config.ConfigurationSet)
func Unmarshal(flagset *pflag.FlagSet, out interface{}, opts ...BinderOption) error
type BinderOption
- func IgnoreFlagNotFound() BinderOption

Constants ¶

View Source

const (
	// TagName defines the name of struct tag to look for
	TagName = "flag"
)

Variables ¶

View Source

var (
	ErrMustBePtr           = errors.New("must marshall into a pointer")
	ErrNilStruct           = errors.New("cannot unmarshall flags into nil structure")
	ErrRequireStruct       = errors.New(("must unmarshall into struct"))
	ErrFieldNotAddressable = errors.New("field cannot be set as its not addressable")
	ErrFlagNotFound        = errors.New("flag not found in flagset")
	ErrUnsupportedType     = errors.New("type not supported for unmarshalling")
)

View Source

var (
	// ErrFlagMissing is an error when there is no flag with a given name
	ErrFlagMissing = errors.New("flag missing")
)

Functions ¶

func BindFlags ¶

func BindFlags(cmd *cobra.Command)

func ConvertToMap ¶

func ConvertToMap(fs *pflag.FlagSet) map[string]string

ConvertToMap will convert a flagset to a map

func CopyFlagValue ¶

func CopyFlagValue(sourceFlagName, destinationFlagName string, fs *pflag.FlagSet, ignoreNotFound bool) error

func CreateCommandFlags ¶

func CreateCommandFlags(cmd *cobra.Command, cs config.ConfigurationSet) error

func CreateFlagsFromConfig ¶

func CreateFlagsFromConfig(cs config.ConfigurationSet) (*pflag.FlagSet, error)

CreateFlagsFromConfig will create a FlagSet from a configuration set

func ExistsWithValue ¶

func ExistsWithValue(name string, flags *pflag.FlagSet) bool

ExistsWithValue returns true if a flag exists in a flagset and has a value and that value is non-empty

func GetFlagValueDirect ¶

func GetFlagValueDirect(args []string, longName, shortName string) (string, error)

GetFlagValueDirect will get a flag value directly from args or config. Note: this should only be used in exceptional circumstances

func ParseFlagMultiValueToMap ¶

func ParseFlagMultiValueToMap(flag string) map[string]string

func PopulateConfigFromCommand ¶

func PopulateConfigFromCommand(cmd *cobra.Command, cs config.ConfigurationSet)

func PopulateConfigFromFlags ¶

func PopulateConfigFromFlags(flags *pflag.FlagSet, cs config.ConfigurationSet)

func Unmarshal ¶

func Unmarshal(flagset *pflag.FlagSet, out interface{}, opts ...BinderOption) error

Unmarshal will decode the flagset into the out interface

Types ¶

type BinderOption ¶

type BinderOption func(*flagBinder)

BinderOption defines a functional option for creations of the flags binder

func IgnoreFlagNotFound ¶

func IgnoreFlagNotFound() BinderOption

IgnoreFlagNotFound is an option that specifies that if a flag doesn't exist then no error should be returned

Source Files ¶

View all Source files

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