gconf

package module

Go to main page

Versions in this module

v4

v4.3.0

May 12, 2020

Changes in this version

+ var AddressOrIPSliceValidator = NewAddressOrIPSliceValidator()

+ var AddressOrIPValidator = NewAddressOrIPValidator()

+ var AddressSliceValidator = NewAddressSliceValidator()

+ var AddressValidator = NewAddressValidator()

+ var EmailSliceValidator = NewEmailSliceValidator()

+ var EmailValidator = NewEmailValidator()

+ var EmptyStrValidator = NewEmptyStrValidator()

+ var IPSliceValidator = NewIPSliceValidator()

+ var IPValidator = NewIPValidator()

+ var MaybeAddressOrIPValidator = NewMaybeAddressOrIPValidator()

+ var MaybeAddressValidator = NewMaybeAddressValidator()

+ var MaybeEmailValidator = NewMaybeEmailValidator()

+ var MaybeIPValidator = NewMaybeIPValidator()

+ var MaybeURLValidator = NewMaybeURLValidator()

+ var PortValidator = NewPortValidator()

+ var StrNotEmptyValidator = NewStrNotEmptyValidator()

+ var URLSliceValidator = NewURLSliceValidator()

+ var URLValidator = NewURLValidator()

v4.2.0

Oct 10, 2019

Changes in this version

type Opt

+ Fix func(input interface{}) (output interface{}, err error)

+ func (o Opt) F(fix func(interface{}) (interface{}, error), fixDefault ...bool) Opt

type Validator

+ func NewAddressOrIPSliceValidator() Validator

+ func NewAddressOrIPValidator() Validator

+ func NewMaybeAddressOrIPValidator() Validator

+ func NewMaybeAddressValidator() Validator

+ func NewMaybeEmailValidator() Validator

+ func NewMaybeIPValidator() Validator

+ func NewMaybeURLValidator() Validator

v4.1.0

Sep 11, 2019

Changes in this version

type OptGroup

+ func (g *OptGroup) Migrate(oldOptName, newGroupOptName string)

v4.0.1

Sep 10, 2019

v4.0.0

Sep 10, 2019

Changes in this version

+ var Conf = New()

+ var ConfigFileOpt = StrOpt("config-file", "the config file path.")

+ var DefaultWriter = os.Stdout

+ var ErrFrozenOpt = fmt.Errorf("option is frozen")

+ var ErrNoOpt = fmt.Errorf("no option")

+ var ToBool = types.ToBool

+ var ToDuration = types.ToDuration

+ var ToDurationSlice = toDurationSlice

+ var ToFloat64 = types.ToFloat64

+ var ToFloat64Slice = toFloat64Slice

+ var ToInt = types.ToInt

+ var ToInt32 = types.ToInt32

+ var ToInt64 = types.ToInt64

+ var ToIntSlice = toIntSlice

+ var ToString = types.ToString

+ var ToStringSlice = toStringSlice

+ var ToTime = toTime

+ var ToUint = types.ToUint

+ var ToUint32 = types.ToUint32

+ var ToUint64 = types.ToUint64

+ var ToUintSlice = toUintSlice

+ var VersionOpt = StrOpt("version", "Print the version and exit.").S("v").D("1.0.0").V(NewStrNotEmptyValidator())

+ func AddAndParseOptFlag(c *Config, flagSet ...*flag.FlagSet) error

+ func AddDecoder(decoder Decoder, force ...bool) (ok bool)

+ func AddDecoderAlias(_type, alias string)

+ func AddOptFlag(c *Config, flagSet ...*flag.FlagSet)

+ func Close()

+ func CloseNotice() <-chan struct

+ func ConvertOptsToCliFlags(group *OptGroup, prefix ...string) []cli.Flag

+ func ErrorHandler(h func(err error)) func(error)

+ func FreezeOpt(names ...string)

+ func Get(name string) (value interface{})

+ func GetBool(name string) bool

+ func GetDuration(name string) time.Duration

+ func GetDurationSlice(name string) []time.Duration

+ func GetFloat64(name string) float64

+ func GetFloat64Slice(name string) []float64

+ func GetInt(name string) int

+ func GetInt32(name string) int32

+ func GetInt64(name string) int64

+ func GetIntSlice(name string) []int

+ func GetString(name string) string

+ func GetStringSlice(name string) []string

+ func GetTime(name string) time.Time

+ func GetUint(name string) uint

+ func GetUint32(name string) uint32

+ func GetUint64(name string) uint64

+ func GetUintSlice(name string) []uint

+ func IsErrFrozenOpt(err error) bool

+ func IsErrNoOpt(err error) bool

+ func LoadBackupFile(filename string) error

+ func LoadDataSet(ds DataSet, force ...bool)

+ func LoadMap(m map[string]interface{}, force ...bool)

+ func LoadSource(source Source, force ...bool)

+ func LoadSourceAndCallback(source Source, cb func(DataSet), force ...bool)

+ func LoadSourceAndCallbackWithoutWatch(source Source, cb func(DataSet), force ...bool)

+ func LoadSourceWithoutWatch(source Source, force ...bool)

+ func Must(name string) (value interface{})

+ func MustBool(name string) bool

+ func MustDuration(name string) time.Duration

+ func MustDurationSlice(name string) []time.Duration

+ func MustFloat64(name string) float64

+ func MustFloat64Slice(name string) []float64

+ func MustInt(name string) int

+ func MustInt32(name string) int32

+ func MustInt64(name string) int64

+ func MustIntSlice(name string) []int

+ func MustString(name string) string

+ func MustStringSlice(name string) []string

+ func MustTime(name string) time.Time

+ func MustUint(name string) uint

+ func MustUint32(name string) uint32

+ func MustUint64(name string) uint64

+ func MustUintSlice(name string) []uint

+ func Observe(observer func(group string, opt string, oldValue, newValue interface{}))

+ func ObserveRegister(observer func(group string, opts []Opt))

+ func OptIsFrozen(name string) (frozen bool)

+ func PrintFlagUsage(flagSet *flag.FlagSet)

+ func RegisterOpt(opt Opt, force ...bool) (ok bool)

+ func RegisterOpts(opts []Opt, force ...bool) (ok bool)

+ func RegisterStruct(v interface{})

+ func SetErrHandler(handler func(error))

+ func SetStringVersion(version string)

+ func SetVersion(version Opt)

+ func Snapshot() map[string]interface

+ func Traverse(f func(group string, opt string, value interface{}))

+ func UnfreezeOpt(names ...string)

+ func UpdateOptValue(groupName, optName string, optValue interface{})

+ func UpdateValue(key string, value interface{})

+ type BoolOptField struct

+ func (f *BoolOptField) Default() interface{}

+ func (f *BoolOptField) Get() bool

+ func (f *BoolOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *BoolOptField) Set(v interface{})

+ type BoolTOptField struct

+ func (f *BoolTOptField) Default() interface{}

+ func (f *BoolTOptField) Get() bool

+ func (f *BoolTOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *BoolTOptField) Set(v interface{})

+ type Config struct

+ func New() *Config

+ func (c *Config) AddDecoder(decoder Decoder, force ...bool) (ok bool)

+ func (c *Config) AddDecoderAlias(_type, alias string)

+ func (c *Config) AllGroups() []*OptGroup

+ func (c *Config) Close()

+ func (c *Config) CloseNotice() <-chan struct{}

+ func (c *Config) GetDecoder(_type string) (decoder Decoder, ok bool)

+ func (c *Config) GetVersion() (version Opt)

+ func (c *Config) LoadBackupFile(filename string) error

+ func (c *Config) LoadDataSet(ds DataSet, force ...bool)

+ func (c *Config) LoadMap(m map[string]interface{}, force ...bool)

+ func (c *Config) LoadSource(source Source, force ...bool)

+ func (c *Config) LoadSourceAndCallback(source Source, cb func(DataSet), force ...bool)

+ func (c *Config) LoadSourceAndCallbackWithoutWatch(source Source, cb func(DataSet), force ...bool)

+ func (c *Config) LoadSourceWithoutWatch(source Source, force ...bool)

+ func (c *Config) Observe(observer func(group string, opt string, oldValue, newValue interface{}))

+ func (c *Config) ObserveRegister(observer func(group string, opts []Opt))

+ func (c *Config) PrintGroup(w io.Writer) error

+ func (c *Config) SetErrHandler(h func(error))

+ func (c *Config) SetStringVersion(version string)

+ func (c *Config) SetVersion(version Opt)

+ func (c *Config) Snapshot() map[string]interface{}

+ func (c *Config) Traverse(f func(group string, opt string, value interface{}))

+ func (c *Config) UpdateOptValue(groupName, optName string, optValue interface{})

+ func (c *Config) UpdateValue(key string, value interface{})

+ type DataSet struct

+ Callback func(DataSet)

+ Checksum string

+ Data []byte

+ Format string

+ Source string

+ Timestamp time.Time

+ func (ds DataSet) Md5() string

+ func (ds DataSet) Sha256() string

+ type Decoder struct

+ Decode func(src []byte, dst map[string]interface{}) error

+ Type string

+ func GetDecoder(_type string) (decoder Decoder, ok bool)

+ func NewDecoder(_type string, decode func([]byte, map[string]interface{}) error) Decoder

+ func NewIniDecoder(defaultGroupName ...string) Decoder

+ func NewJSONDecoder() Decoder

+ func NewTomlDecoder() Decoder

+ func NewYamlDecoder() Decoder

+ type DurationOptField struct

+ func (f *DurationOptField) Default() interface{}

+ func (f *DurationOptField) Get() time.Duration

+ func (f *DurationOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *DurationOptField) Set(v interface{})

+ type DurationSliceOptField struct

+ func (f *DurationSliceOptField) Default() interface{}

+ func (f *DurationSliceOptField) Get() []time.Duration

+ func (f *DurationSliceOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *DurationSliceOptField) Set(v interface{})

+ type Float64OptField struct

+ func (f *Float64OptField) Default() interface{}

+ func (f *Float64OptField) Get() float64

+ func (f *Float64OptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *Float64OptField) Set(v interface{})

+ type Float64SliceOptField struct

+ func (f *Float64SliceOptField) Default() interface{}

+ func (f *Float64SliceOptField) Get() []float64

+ func (f *Float64SliceOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *Float64SliceOptField) Set(v interface{})

+ type Int32OptField struct

+ func (f *Int32OptField) Default() interface{}

+ func (f *Int32OptField) Get() int32

+ func (f *Int32OptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *Int32OptField) Set(v interface{})

+ type Int64OptField struct

+ func (f *Int64OptField) Default() interface{}

+ func (f *Int64OptField) Get() int64

+ func (f *Int64OptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *Int64OptField) Set(v interface{})

+ type IntOptField struct

+ func (f *IntOptField) Default() interface{}

+ func (f *IntOptField) Get() int

+ func (f *IntOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *IntOptField) Set(v interface{})

+ type IntSliceOptField struct

+ func (f *IntSliceOptField) Default() interface{}

+ func (f *IntSliceOptField) Get() []int

+ func (f *IntSliceOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *IntSliceOptField) Set(v interface{})

+ type Opt struct

+ Aliases []string

+ Cli bool

+ Default interface{}

+ Help string

+ Name string

+ Observers []func(newValue interface{})

+ Parser func(input interface{}) (output interface{}, err error)

+ Short string

+ Tags map[string]string

+ Validators []Validator

+ func BoolOpt(name string, help string) Opt

+ func DurationOpt(name string, help string) Opt

+ func DurationSliceOpt(name string, help string) Opt

+ func Float64Opt(name string, help string) Opt

+ func Float64SliceOpt(name string, help string) Opt

+ func GetVersion() Opt

+ func Int32Opt(name string, help string) Opt

+ func Int64Opt(name string, help string) Opt

+ func IntOpt(name string, help string) Opt

+ func IntSliceOpt(name string, help string) Opt

+ func NewOpt(name string, _default interface{}, ...) Opt

+ func StrOpt(name string, help string) Opt

+ func StrSliceOpt(name string, help string) Opt

+ func TimeOpt(name string, help string) Opt

+ func Uint32Opt(name string, help string) Opt

+ func Uint64Opt(name string, help string) Opt

+ func UintOpt(name string, help string) Opt

+ func UintSliceOpt(name string, help string) Opt

+ func (o Opt) As(aliases ...string) Opt

+ func (o Opt) C(cli bool) Opt

+ func (o Opt) D(_default interface{}) Opt

+ func (o Opt) H(help string) Opt

+ func (o Opt) N(name string) Opt

+ func (o Opt) O(observers ...func(interface{})) Opt

+ func (o Opt) P(parser func(interface{}) (interface{}, error)) Opt

+ func (o Opt) S(shortName string) Opt

+ func (o Opt) T(key, value string) Opt

+ func (o Opt) V(validators ...Validator) Opt

+ type OptError struct

+ Err error

+ Group string

+ Opt string

+ Value interface{}

+ func NewOptError(group, opt string, err error, value interface{}) OptError

+ func (e OptError) Error() string

+ type OptField interface

+ Default func() interface{}

+ Parse func(input interface{}) (output interface{}, err error)

+ Set func(interface{})

+ type OptGroup struct

+ func AllGroups() []*OptGroup

+ func G(group string) *OptGroup

+ func Group(group string) *OptGroup

+ func MustG(group string) *OptGroup

+ func MustGroup(group string) *OptGroup

+ func NewGroup(group string) *OptGroup

+ func (g *OptGroup) AllOpts() []Opt

+ func (g *OptGroup) Config() *Config

+ func (g *OptGroup) FreezeGroup()

+ func (g *OptGroup) FreezeOpt(names ...string)

+ func (g *OptGroup) G(group string) *OptGroup

+ func (g *OptGroup) Get(name string) (value interface{})

+ func (g *OptGroup) GetBool(name string) bool

+ func (g *OptGroup) GetDuration(name string) time.Duration

+ func (g *OptGroup) GetDurationSlice(name string) []time.Duration

+ func (g *OptGroup) GetFloat64(name string) float64

+ func (g *OptGroup) GetFloat64Slice(name string) []float64

+ func (g *OptGroup) GetInt(name string) int

+ func (g *OptGroup) GetInt32(name string) int32

+ func (g *OptGroup) GetInt64(name string) int64

+ func (g *OptGroup) GetIntSlice(name string) []int

+ func (g *OptGroup) GetString(name string) string

+ func (g *OptGroup) GetStringSlice(name string) []string

+ func (g *OptGroup) GetTime(name string) time.Time

+ func (g *OptGroup) GetUint(name string) uint

+ func (g *OptGroup) GetUint32(name string) uint32

+ func (g *OptGroup) GetUint64(name string) uint64

+ func (g *OptGroup) GetUintSlice(name string) []uint

+ func (g *OptGroup) Group(group string) *OptGroup

+ func (g *OptGroup) GroupIsFrozen() (frozen bool)

+ func (g *OptGroup) HasOpt(name string) bool

+ func (g *OptGroup) HasOptAndIsNotSet(name string) (yes bool)

+ func (g *OptGroup) Must(name string) (value interface{})

+ func (g *OptGroup) MustBool(name string) bool

+ func (g *OptGroup) MustDuration(name string) time.Duration

+ func (g *OptGroup) MustDurationSlice(name string) []time.Duration

+ func (g *OptGroup) MustFloat64(name string) float64

+ func (g *OptGroup) MustFloat64Slice(name string) []float64

+ func (g *OptGroup) MustG(group string) *OptGroup

+ func (g *OptGroup) MustGroup(group string) *OptGroup

+ func (g *OptGroup) MustInt(name string) int

+ func (g *OptGroup) MustInt32(name string) int32

+ func (g *OptGroup) MustInt64(name string) int64

+ func (g *OptGroup) MustIntSlice(name string) []int

+ func (g *OptGroup) MustOpt(name string) Opt

+ func (g *OptGroup) MustString(name string) string

+ func (g *OptGroup) MustStringSlice(name string) []string

+ func (g *OptGroup) MustTime(name string) time.Time

+ func (g *OptGroup) MustUint(name string) uint

+ func (g *OptGroup) MustUint32(name string) uint32

+ func (g *OptGroup) MustUint64(name string) uint64

+ func (g *OptGroup) MustUintSlice(name string) []uint

+ func (g *OptGroup) Name() string

+ func (g *OptGroup) NewGroup(group string) *OptGroup

+ func (g *OptGroup) Opt(name string) (opt Opt, exist bool)

+ func (g *OptGroup) OptIsFrozen(name string) (frozen bool)

+ func (g *OptGroup) OptIsSet(name string) bool

+ func (g *OptGroup) Parse(name string, value interface{}) (interface{}, error)

+ func (g *OptGroup) RegisterOpt(opt Opt, force ...bool) (ok bool)

+ func (g *OptGroup) RegisterOpts(opts []Opt, force ...bool) (ok bool)

+ func (g *OptGroup) RegisterStruct(v interface{})

+ func (g *OptGroup) Set(name string, value interface{})

+ func (g *OptGroup) SetOptAlias(old, new string)

+ func (g *OptGroup) UnfreezeGroup()

+ func (g *OptGroup) UnfreezeOpt(names ...string)

+ type SafeValue struct

+ func (sv *SafeValue) Get(_default interface{}) (value interface{})

+ func (sv *SafeValue) Set(v interface{})

+ type Source interface

+ Read func() (DataSet, error)

+ Watch func(load func(DataSet, error), close <-chan struct{})

+ func NewCliSource(ctx *cli.Context, groups ...string) Source

+ func NewEnvSource(prefix ...string) Source

+ func NewFileSource(filename string, defaultFormat ...string) Source

+ func NewFlagSource(flagSet ...*flag.FlagSet) Source

+ func NewURLSource(url string, interval time.Duration, format ...string) Source

+ func NewZkConnSource(conn *zk.Conn, path, format string, hosts ...string) Source

+ func NewZkSource(hosts []string, path, format string, timeout time.Duration, ...) Source

+ type SourceError struct

+ Data []byte

+ Err error

+ Format string

+ Source string

+ func NewSourceError(source, format string, data []byte, err error) SourceError

+ func (se SourceError) Error() string

+ type StringOptField struct

+ func (f *StringOptField) Default() interface{}

+ func (f *StringOptField) Get() string

+ func (f *StringOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *StringOptField) Set(v interface{})

+ type StringSliceOptField struct

+ func (f *StringSliceOptField) Default() interface{}

+ func (f *StringSliceOptField) Get() []string

+ func (f *StringSliceOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *StringSliceOptField) Set(v interface{})

+ type TimeOptField struct

+ func (f *TimeOptField) Default() interface{}

+ func (f *TimeOptField) Get() time.Time

+ func (f *TimeOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *TimeOptField) Set(v interface{})

+ type Uint32OptField struct

+ func (f *Uint32OptField) Default() interface{}

+ func (f *Uint32OptField) Get() uint32

+ func (f *Uint32OptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *Uint32OptField) Set(v interface{})

+ type Uint64OptField struct

+ func (f *Uint64OptField) Default() interface{}

+ func (f *Uint64OptField) Get() uint64

+ func (f *Uint64OptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *Uint64OptField) Set(v interface{})

+ type UintOptField struct

+ func (f *UintOptField) Default() interface{}

+ func (f *UintOptField) Get() uint

+ func (f *UintOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *UintOptField) Set(v interface{})

+ type UintSliceOptField struct

+ func (f *UintSliceOptField) Default() interface{}

+ func (f *UintSliceOptField) Get() []uint

+ func (f *UintSliceOptField) Parse(input interface{}) (output interface{}, err error)

+ func (f *UintSliceOptField) Set(v interface{})

+ type Validator func(value interface{}) error

+ func NewAddressSliceValidator() Validator

+ func NewAddressValidator() Validator

+ func NewEmailSliceValidator() Validator

+ func NewEmailValidator() Validator

+ func NewEmptyStrValidator() Validator

+ func NewFloatRangeValidator(min, max float64) Validator

+ func NewIPSliceValidator() Validator

+ func NewIPValidator() Validator

+ func NewIntegerRangeValidator(min, max int64) Validator

+ func NewPortValidator() Validator

+ func NewRegexpValidator(pattern string) Validator

+ func NewStrArrayValidator(array []string) Validator

+ func NewStrLenValidator(min, max int) Validator

+ func NewStrNotEmptyValidator() Validator

+ func NewStrSliceValidator(strValidators ...Validator) Validator

+ func NewURLSliceValidator() Validator

+ func NewURLValidator() Validator

+ func Or(validators ...Validator) Validator

Other modules containing this package

github.com/xgfone/gconf

github.com/xgfone/gconf/v5

github.com/xgfone/gconf/v6

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