env

Nov 18, 2025

Changes in this version

+ var DebugLogger func(format string, args ...interface{})

+ func EnableDebugLogging(logger func(format string, args ...interface{}))

+ func GetRequiredVars(v interface{}, prefix string) ([]string, error)

+ func MustGetWithContext(key, context string) string

+ func SetForTest(t TestHelper, key, value string) func()

+ func UnsetForTest(t TestHelper, key string) func()

+ func ValidateRequired(v interface{}, prefix string) error

+ type TestHelper interface

+ Cleanup func(func())

+ Helper func()

+ type VarInfo struct

+ Default string

+ FieldName string

+ FieldPath string

+ HasDefault bool

+ Name string

+ Required bool

+ Type string

+ func GetAllVars(v interface{}, prefix string) ([]VarInfo, error)

Sep 27, 2025

Changes in this version

+ const DecimalBase

+ const Float32Bits

+ const Float64Bits

+ const Int32Bits

+ const Int64Bits

+ var ParseBool = func(s string) (bool, error)

+ var ParseDuration = func(s string) (time.Duration, error)

+ var ParseFloat32 = func(s string) (float32, error)

+ var ParseFloat64 = func(s string) (float64, error)

+ var ParseInt = func(s string) (int, error)

+ var ParseInt64 = func(s string) (int64, error)

+ var ParseURL = func(s string) (*url.URL, error)

+ var ParseUint = func(s string) (uint, error)

+ var ParseUint64 = func(s string) (uint64, error)

+ func GetOrParsed[T any](key string, defaultValue T, parser Parser[T]) T

+ func GetParsed[T any](key string, parser Parser[T]) (T, error)

+ func MustGetParsed[T any](key string, parser Parser[T], typeName string) T

+ type ParseErrors []error

+ func (pe ParseErrors) Error() string

+ type Parser func(string) (T, error)

May 3, 2019

Changes in this version

+ func GetDuration(key string) (time.Duration, error)

+ func GetFloat64(key string) (float64, error)

+ func GetInt64(key string) (int64, error)

+ func GetOrDuration(key string, defaultValue string) time.Duration

+ func GetOrFloat64(key string, defaultValue float64) float64

+ func GetOrInt64(key string, defaultValue int64) int64

+ func GetOrUint64(key string, defaultValue uint64) uint64

+ func GetOrUrl(key string, defaultValue string) *url.URL

+ func GetUint64(key string) (uint64, error)

+ func GetUrl(key string) (*url.URL, error)

+ func MustGetDuration(key string) time.Duration

+ func MustGetFloat64(key string) float64

+ func MustGetInt64(key string) int64

+ func MustGetUint64(key string) uint64

+ func MustGetUrl(key string) *url.URL

Apr 11, 2019

Changes in this version

+ func GetFloat32(key string) (float32, error)

+ func GetOrFloat32(key string, defaultValue float32) float32

+ func MustGetFloat32(key string) float32

+ func MustLoad(filenames ...string)

+ func MustOverload(filenames ...string)

Apr 11, 2019

Changes in this version

+ func GetBool(key string) (bool, error)

+ func GetFloat(key string) (float32, error)

+ func GetInt(key string) (int, error)

+ func GetOrBool(key string, defaultValue bool) bool

+ func GetOrFloat(key string, defaultValue float32) float32

+ func GetOrInt(key string, defaultValue int) int

+ func GetOrUint(key string, defaultValue uint) uint

+ func GetUint(key string) (uint, error)

+ func MustGetBool(key string) bool

+ func MustGetFloat(key string) float32

+ func MustGetInt(key string) int

+ func MustGetUint(key string) uint

Apr 11, 2019

Changes in this version

+ func Load(filenames ...string) (err error)

+ func Marshal(envMap map[string]string) (string, error)

+ func Overload(filenames ...string) (err error)

+ func ParseIO(r io.Reader) (envMap map[string]string, err error)

+ func Read(filenames ...string) (envMap map[string]string, err error)

+ func Unmarshal(str string) (envMap map[string]string, err error)

+ func Write(envMap map[string]string, filename string) error

Feb 12, 2019

Changes in this version

+ func Get(key string) string

+ func GetOr(key, defaultValue string) string

+ func MustGet(key, defaultValue string) string

+ func Set(key, value string) error

+ func Unset(key string) error

Feb 12, 2019

Changes in this version

+ var ErrNotAStructPtr = errors.New("Expected a pointer to a Struct")

+ var ErrUnsupportedSliceType = errors.New("Unsupported slice type")

+ var ErrUnsupportedType = errors.New("Type is not supported")

+ var OnEnvVarSet func(reflect.StructField, string)

+ func Parse(v interface{}) error

+ func ParseWithFuncs(v interface{}, funcMap CustomParsers) error

+ func ParseWithPrefix(v interface{}, prefix string) error

+ func ParseWithPrefixFuncs(v interface{}, prefix string, funcMap CustomParsers) error

+ type CustomParsers map[reflect.Type]ParserFunc

+ type ParserFunc func(v string) (interface{}, error)