pflags

Documentation

Index

• Variables
• func BindPFlag(key string, flag *pflag.Flag)
• func Duration(key string, defaultValue time.Duration, usage string) func() time.Duration
• func DurationRequired(key, usage string) func() time.Duration
• func GetServiceName() string
• func OverrideDefaultConfigFile(configFile string)
• func Parse(opts ...OptionFunc)
• func SetDefaultConfigReader(reader reader.ConfigReader)
• func SetDefaultConfigWatcher(watchers watcher.ConfigWatcher)
• func SetStructParseTagName(t string)
• func Struct(key string, defaultVal any, usage string) func(out any) error
• func Viper() *viper.Viper
• type BoolGetter
  • func Bool(key string, defaultVal bool, usage string) BoolGetter
  • func BoolRequired(key, usage string) BoolGetter
  • func (bg BoolGetter) Value() bool
• type Float64Getter
  • func Float64(key string, defaultVal float64, usage string) Float64Getter
  • func Float64Required(key, usage string) Float64Getter
  • func (fg Float64Getter) Value() float64
• type HasDefault
• type HasReloader
• type HasValidator
• type IntGetter
  • func Int(key string, defaultVal int, usage string) IntGetter
  • func IntRequired(key, usage string) IntGetter
  • func (ig IntGetter) Value() int
• type Option
• type OptionFunc
  • func WithConfigFileName(n string) OptionFunc
  • func WithConfigFileType(t string) OptionFunc
  • func WithConfigReader(reader reader.ConfigReader) OptionFunc
  • func WithConfigWatcher(watchers ...watcher.ConfigWatcher) OptionFunc
• type StringGetter
  • func String(key, defaultVal, usage string) StringGetter
  • func StringP(key, shorthand, defaultVal, usage string) StringGetter
  • func StringRequired(key, usage string) StringGetter
  • func (sg StringGetter) Value() string
• type StringSliceGetter
  • func StringSlice(key string, defaultVal []string, usage string) StringSliceGetter
  • func (sg StringSliceGetter) Value() []string

Variables

var (
	ErrNotStruct = errors.New("not struct")
)

Functions

func BindPFlag

func BindPFlag(key string, flag *pflag.Flag)

func Duration

func Duration(key string, defaultValue time.Duration, usage string) func() time.Duration

func DurationRequired

func DurationRequired(key, usage string) func() time.Duration

func GetServiceName

func GetServiceName() string

func OverrideDefaultConfigFile

func OverrideDefaultConfigFile(configFile string)

func Parse

func Parse(opts ...OptionFunc)

func SetDefaultConfigReader

func SetDefaultConfigReader(reader reader.ConfigReader)

func SetDefaultConfigWatcher

func SetDefaultConfigWatcher(watchers watcher.ConfigWatcher)

func SetStructParseTagName

func SetStructParseTagName(t string)

func Struct

func Struct(key string, defaultVal any, usage string) func(out any) error

func Viper

func Viper() *viper.Viper

Types

type BoolGetter

type BoolGetter func() bool

func Bool

func Bool(key string, defaultVal bool, usage string) BoolGetter

func BoolRequired

func BoolRequired(key, usage string) BoolGetter

func (BoolGetter) Value

func (bg BoolGetter) Value() bool

type Float64Getter

type Float64Getter func() float64

func Float64

func Float64(key string, defaultVal float64, usage string) Float64Getter

func Float64Required

func Float64Required(key, usage string) Float64Getter

func (Float64Getter) Value

func (fg Float64Getter) Value() float64

type HasDefault

type HasDefault interface {
	SetDefault()
}

type HasReloader

type HasReloader interface {
	Reload()
}

type HasValidator

type HasValidator interface {
	Validate() error
}

type IntGetter

type IntGetter func() int

func Int

func Int(key string, defaultVal int, usage string) IntGetter

func IntRequired

func IntRequired(key, usage string) IntGetter

func (IntGetter) Value

func (ig IntGetter) Value() int

type Option

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

type OptionFunc

type OptionFunc func(*Option)

func WithConfigFileName

func WithConfigFileName(n string) OptionFunc

func WithConfigFileType

func WithConfigFileType(t string) OptionFunc

func WithConfigReader

func WithConfigReader(reader reader.ConfigReader) OptionFunc

func WithConfigWatcher

func WithConfigWatcher(watchers ...watcher.ConfigWatcher) OptionFunc

type StringGetter

type StringGetter func() string

func String

func String(key, defaultVal, usage string) StringGetter

func StringP

func StringP(key, shorthand, defaultVal, usage string) StringGetter

func StringRequired

func StringRequired(key, usage string) StringGetter

func (StringGetter) Value

func (sg StringGetter) Value() string

type StringSliceGetter

type StringSliceGetter func() []string

func StringSlice

func StringSlice(key string, defaultVal []string, usage string) StringSliceGetter

func (StringSliceGetter) Value

func (sg StringSliceGetter) Value() []string