params

Documentation

Index

• func FlagErr(flagName, format string, a ...any) error
• func GetParamByName(paramName, paramsStr string) (string, error)
• func Map(flagName, paramsStr string, obj interface{}) error
• func SplitPrefixedName(prefixedName string) (prefix string, name string, err error)
• func Supported(obj interface{}) string
• type NotFoundError
  • func (e NotFoundError) Error() string
  • func (e NotFoundError) Is(target error) bool

Functions

func FlagErr

func FlagErr(flagName, format string, a ...any) error

func GetParamByName

func GetParamByName(paramName, paramsStr string) (string, error)

func Map

func Map(flagName, paramsStr string, obj interface{}) error

Map assigns the parameter value into the right struct field, which is represented by obj. For example, if we use Map("param1", "value1", &myFlag) with MyFlag struct above, Param1 field would be assigned with "value1".

func SplitPrefixedName

func SplitPrefixedName(prefixedName string) (prefix string, name string, err error)

SplitPrefixedName splits prefixedName with "/" as a separator

func Supported

func Supported(obj interface{}) string

Supported returns the list of supported flags for a parameter struct. This is mainly used to show the user the list of supported parameters

Types

type NotFoundError

type NotFoundError struct {
	Name string
}

func (NotFoundError) Error

func (e NotFoundError) Error() string

func (NotFoundError) Is

func (e NotFoundError) Is(target error) bool