Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ucfg

package

Go to main page

Versions in this module

v1

v1.1.5

Mar 31, 2025

v1.1.4

Mar 14, 2025

v1.1.3

Feb 28, 2025

v1.1.2

Feb 17, 2025

v1.1.0

Jan 11, 2025

v1.0.0

Dec 16, 2024

Changes in this version

+ const SecretShadowText

+ const SecretStringDelimiter

+ var AppendValues = makeOptValueHandling(cfgArrAppend)

+ var ErrArrayEmpty = errors.New("empty array")

+ var ErrArraySizeMismatch = errors.New("Array size mismatch")

+ var ErrConfig = errors.New("Configuration error")

+ var ErrCyclicReference = errors.New("cyclic reference detected")

+ var ErrDuplicateKey = errors.New("duplicate key")

+ var ErrDuplicateValidator = errors.New("validator already registered")

+ var ErrEmpty = errors.New("empty field")

+ var ErrExpectedObject = errors.New("expected object")

+ var ErrImplementation = errors.New("Implementation error")

+ var ErrIndexOutOfRange = errors.New("out of range index")

+ var ErrKeyTypeNotString = errors.New("key must be a string")

+ var ErrMapEmpty = errors.New("empty map")

+ var ErrMissing = errors.New("missing field")

+ var ErrNegative = errors.New("negative value")

+ var ErrNilConfig = errors.New("config is nil")

+ var ErrNilValue = errors.New("nil value is invalid")

+ var ErrNoParse = errors.New("parsing dynamic configs is disabled")

+ var ErrOverflow = errors.New("integer overflow")

+ var ErrPointerRequired = errors.New("pointer required for unpacking configurations")

+ var ErrRegexEmpty = errors.New("regex value is not set")

+ var ErrRequired = errors.New("missing required field")

+ var ErrStringEmpty = errors.New("string value is not set")

+ var ErrTODO = errors.New("TODO - implement me")

+ var ErrTypeMismatch = errors.New("type mismatch")

+ var ErrTypeNoArray = errors.New("field is no array")

+ var ErrUnknown = errors.New("Unspecified")

+ var ErrZeroValue = errors.New("zero value")

+ var FieldAppendValues = makeFieldOptValueHandling(cfgArrAppend)

+ var FieldMergeValues = makeFieldOptValueHandling(cfgMergeValues)

+ var FieldPrependValues = makeFieldOptValueHandling(cfgArrPrepend)

+ var FieldReplaceValues = makeFieldOptValueHandling(cfgReplaceValue)

+ var PrependValues = makeOptValueHandling(cfgArrPrepend)

+ var ReplaceValues = makeOptValueHandling(cfgReplaceValue)

+ func DecodeSecretString(s string) (string, string)

+ func RegisterValidator(name string, cb ValidatorCallback) error

+ type BoolUnpacker interface

+ Unpack func(b bool) error

+ type Config struct

+ func MustNewFrom(from interface{}, opts ...Option) *Config

+ func New() *Config

+ func NewFrom(from interface{}, opts ...Option) (*Config, error)

+ func (c *Config) Bool(name string, idx int, opts ...Option) (bool, error)

+ func (c *Config) Child(name string, idx int, opts ...Option) (*Config, error)

+ func (c *Config) CountField(name string, opts ...Option) (int, error)

+ func (c *Config) FlattenedKeys(opts ...Option) []string

+ func (c *Config) Float(name string, idx int, opts ...Option) (float64, error)

+ func (c *Config) GetFields() []string

+ func (c *Config) Has(name string, idx int, options ...Option) (bool, error)

+ func (c *Config) HasField(name string) bool

+ func (c *Config) Int(name string, idx int, opts ...Option) (int64, error)

+ func (c *Config) IsArray() bool

+ func (c *Config) IsDict() bool

+ func (c *Config) Merge(from interface{}, options ...Option) error

+ func (c *Config) Parent() *Config

+ func (c *Config) Path(sep string) string

+ func (c *Config) PathOf(field, sep string) string

+ func (c *Config) Remove(name string, idx int, options ...Option) (bool, error)

+ func (c *Config) SetBool(name string, idx int, value bool, opts ...Option) error

+ func (c *Config) SetChild(name string, idx int, value *Config, opts ...Option) error

+ func (c *Config) SetFloat(name string, idx int, value float64, opts ...Option) error

+ func (c *Config) SetInt(name string, idx int, value int64, opts ...Option) error

+ func (c *Config) SetString(name string, idx int, value string, opts ...Option) error

+ func (c *Config) SetUint(name string, idx int, value uint64, opts ...Option) error

+ func (c *Config) String(name string, idx int, opts ...Option) (string, error)

+ func (c *Config) Uint(name string, idx int, opts ...Option) (uint64, error)

+ func (c *Config) Unpack(to interface{}, options ...Option) error

+ func (c *Config) UnpackWithoutOptions(to interface{}) error

+ type ConfigUnpacker interface

+ Unpack func(c *Config) error

+ type Error interface

+ Class func() error

+ Message func() string

+ Path func() string

+ Reason func() error

+ Trace func() string

+ type FloatUnpacker interface

+ Unpack func(f float64) error

+ type Initializer interface

+ InitDefaults func()

+ type IntUnpacker interface

+ Unpack func(i int64) error

+ type Meta struct

+ Source string

+ type Option func(*options)

+ var NoResolve Option = doNoResolve

+ var ResolveEnv Option = doResolveEnv

+ var ResolveNOOP Option = doResolveNOOP

+ var ResolveRef Option = doResolveRef

+ var VarExp Option = doVarExp

+ func DefaultParseConfig(config parse.Config) Option

+ func Env(e *Config) Option

+ func MetaData(meta Meta) Option

+ func PathSep(sep string) Option

+ func Resolve(fn func(name string) (string, parse.Config, error)) Option

+ func StructTag(tag string) Option

+ func ValidatorTag(tag string) Option

+ type SecretString string

+ func EncodeToSecretString(raw string, value string) SecretString

+ func (k *SecretString) UnmarshalJSON(src []byte) error

+ func (k *SecretString) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (k SecretString) Get() string

+ func (k SecretString) GoString() string

+ func (k SecretString) MarshalJSON() ([]byte, error)

+ func (k SecretString) MarshalYAML() (interface{}, error)

+ func (k SecretString) String() string

+ type StringUnpacker interface

+ Unpack func(s string) error

+ type UintUnpacker interface

+ Unpack func(u uint64) error

+ type Unpacker interface

+ Unpack func(interface{}) error

+ type Validator interface

+ Validate func() error

+ type ValidatorCallback func(interface{}, string) error