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
- API
  
  Reference documentation for the pkg.go.dev API
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

configtypes

package module

Go to main page

Versions in this module

v1

v1.2.2

Jun 4, 2026

v1.2.1

Apr 9, 2026

v1.2.0

Jul 3, 2024

Changes in this version

+ type OptBase2Bytes struct

+ func NewOptBase2Bytes(size units.Base2Bytes) OptBase2Bytes

+ func NewOptBase2BytesFromString(sizeAsString string) (OptBase2Bytes, error)

+ func (o *OptBase2Bytes) UnmarshalJSON(data []byte) error

+ func (o *OptBase2Bytes) UnmarshalText(data []byte) error

+ func (o OptBase2Bytes) Get() units.Base2Bytes

+ func (o OptBase2Bytes) GetOrElse(orElseValue units.Base2Bytes) units.Base2Bytes

+ func (o OptBase2Bytes) IsDefined() bool

+ func (o OptBase2Bytes) MarshalJSON() ([]byte, error)

+ func (o OptBase2Bytes) MarshalText() ([]byte, error)

+ func (o OptBase2Bytes) String() string

v1.1.0

Sep 19, 2020

Changes in this version

+ type OptFloat64 struct

+ func NewOptFloat64(value float64) OptFloat64

+ func NewOptFloat64FromString(s string) (OptFloat64, error)

+ func (o *OptFloat64) UnmarshalJSON(data []byte) error

+ func (o *OptFloat64) UnmarshalText(data []byte) error

+ func (o OptFloat64) GetOrElse(orElseValue float64) float64

+ func (o OptFloat64) IsDefined() bool

+ func (o OptFloat64) MarshalJSON() ([]byte, error)

+ func (o OptFloat64) MarshalText() ([]byte, error)

+ func (o OptFloat64) String() string

v1.0.0

Jul 18, 2020

Changes in this version

+ func StringOrElse(value SingleValue, orElseString string) string

+ type Error error

+ type OptBool struct

+ func NewOptBool(value bool) OptBool

+ func NewOptBoolFromString(s string) (OptBool, error)

+ func (o *OptBool) UnmarshalJSON(data []byte) error

+ func (o *OptBool) UnmarshalText(data []byte) error

+ func (o OptBool) GetOrElse(orElseValue bool) bool

+ func (o OptBool) IsDefined() bool

+ func (o OptBool) MarshalJSON() ([]byte, error)

+ func (o OptBool) MarshalText() ([]byte, error)

+ func (o OptBool) String() string

+ type OptDuration struct

+ func NewOptDuration(value time.Duration) OptDuration

+ func NewOptDurationFromString(s string) (OptDuration, error)

+ func (o *OptDuration) UnmarshalJSON(data []byte) error

+ func (o *OptDuration) UnmarshalText(data []byte) error

+ func (o OptDuration) GetOrElse(orElseValue time.Duration) time.Duration

+ func (o OptDuration) IsDefined() bool

+ func (o OptDuration) MarshalJSON() ([]byte, error)

+ func (o OptDuration) MarshalText() ([]byte, error)

+ func (o OptDuration) String() string

+ type OptDurationNonNegative struct

+ func NewOptDurationNonNegative(value time.Duration) (OptDurationNonNegative, error)

+ func NewOptDurationNonNegativeFromString(s string) (OptDurationNonNegative, error)

+ func (o *OptDurationNonNegative) UnmarshalJSON(data []byte) error

+ func (o *OptDurationNonNegative) UnmarshalText(data []byte) error

+ func (o OptDurationNonNegative) GetOrElse(orElseValue time.Duration) time.Duration

+ func (o OptDurationNonNegative) IsDefined() bool

+ func (o OptDurationNonNegative) MarshalJSON() ([]byte, error)

+ func (o OptDurationNonNegative) MarshalText() ([]byte, error)

+ func (o OptDurationNonNegative) String() string

+ type OptInt struct

+ func NewOptInt(value int) OptInt

+ func NewOptIntFromString(s string) (OptInt, error)

+ func (o *OptInt) UnmarshalJSON(data []byte) error

+ func (o *OptInt) UnmarshalText(data []byte) error

+ func (o OptInt) GetOrElse(orElseValue int) int

+ func (o OptInt) IsDefined() bool

+ func (o OptInt) MarshalJSON() ([]byte, error)

+ func (o OptInt) MarshalText() ([]byte, error)

+ func (o OptInt) String() string

+ type OptIntGreaterThanZero struct

+ func NewOptIntGreaterThanZero(value int) (OptIntGreaterThanZero, error)

+ func NewOptIntGreaterThanZeroFromString(s string) (OptIntGreaterThanZero, error)

+ func (o *OptIntGreaterThanZero) UnmarshalJSON(data []byte) error

+ func (o *OptIntGreaterThanZero) UnmarshalText(data []byte) error

+ func (o OptIntGreaterThanZero) GetOrElse(orElseValue int) int

+ func (o OptIntGreaterThanZero) IsDefined() bool

+ func (o OptIntGreaterThanZero) MarshalJSON() ([]byte, error)

+ func (o OptIntGreaterThanZero) MarshalText() ([]byte, error)

+ func (o OptIntGreaterThanZero) String() string

+ type OptString struct

+ func NewOptString(value string) OptString

+ func (o *OptString) UnmarshalJSON(data []byte) error

+ func (o *OptString) UnmarshalText(data []byte) error

+ func (o OptString) GetOrElse(orElseValue string) string

+ func (o OptString) IsDefined() bool

+ func (o OptString) MarshalJSON() ([]byte, error)

+ func (o OptString) MarshalText() ([]byte, error)

+ func (o OptString) String() string

+ type OptStringList struct

+ func NewOptStringList(values []string) OptStringList

+ func NewOptStringListFromString(s string) OptStringList

+ func (o *OptStringList) UnmarshalJSON(data []byte) error

+ func (o *OptStringList) UnmarshalText(data []byte) error

+ func (o OptStringList) IsDefined() bool

+ func (o OptStringList) MarshalJSON() ([]byte, error)

+ func (o OptStringList) MarshalText() ([]byte, error)

+ func (o OptStringList) String() string

+ func (o OptStringList) Values() []string

+ type OptStringNonEmpty struct

+ func NewOptStringNonEmpty(value string) OptStringNonEmpty

+ func (o *OptStringNonEmpty) UnmarshalJSON(data []byte) error

+ func (o *OptStringNonEmpty) UnmarshalText(data []byte) error

+ func (o OptStringNonEmpty) GetOrElse(orElseValue string) string

+ func (o OptStringNonEmpty) IsDefined() bool

+ func (o OptStringNonEmpty) MarshalJSON() ([]byte, error)

+ func (o OptStringNonEmpty) MarshalText() ([]byte, error)

+ func (o OptStringNonEmpty) String() string

+ type OptURL struct

+ func NewOptURL(url *url.URL) OptURL

+ func NewOptURLFromString(urlString string) (OptURL, error)

+ func (o *OptURL) UnmarshalJSON(data []byte) error

+ func (o *OptURL) UnmarshalText(data []byte) error

+ func (o OptURL) Get() *url.URL

+ func (o OptURL) IsDefined() bool

+ func (o OptURL) MarshalJSON() ([]byte, error)

+ func (o OptURL) MarshalText() ([]byte, error)

+ func (o OptURL) String() string

+ type OptURLAbsolute struct

+ func NewOptURLAbsolute(url *url.URL) (OptURLAbsolute, error)

+ func NewOptURLAbsoluteFromString(urlString string) (OptURLAbsolute, error)

+ func (o *OptURLAbsolute) UnmarshalJSON(data []byte) error

+ func (o *OptURLAbsolute) UnmarshalText(data []byte) error

+ func (o OptURLAbsolute) Get() *url.URL

+ func (o OptURLAbsolute) IsDefined() bool

+ func (o OptURLAbsolute) MarshalJSON() ([]byte, error)

+ func (o OptURLAbsolute) MarshalText() ([]byte, error)

+ func (o OptURLAbsolute) String() string

+ type SingleValue interface

+ IsDefined func() bool

+ type Validation interface

+ Validate func() ValidationResult

+ type ValidationAggregateError []ValidationError

+ func (v ValidationAggregateError) Error() string

+ func (v ValidationAggregateError) String() string

+ type ValidationError struct

+ Err error

+ Path ValidationPath

+ func (v ValidationError) Error() string

+ func (v ValidationError) String() string

+ type ValidationPath []string

+ func (p ValidationPath) String() string

+ type ValidationResult struct

+ func ValidateStruct(value interface{}, recursive bool) ValidationResult

+ func (r *ValidationResult) AddAll(prefixPath ValidationPath, other ValidationResult)

+ func (r *ValidationResult) AddError(path ValidationPath, e error)

+ func (r ValidationResult) Errors() []ValidationError

+ func (r ValidationResult) GetError() error

+ func (r ValidationResult) OK() bool

+ type VarReader struct

+ func NewVarReaderFromEnvironment() *VarReader

+ func NewVarReaderFromValues(values map[string]string) *VarReader

+ func (r *VarReader) AddError(path ValidationPath, e error)

+ func (r *VarReader) FindPrefixedValues(prefix string) map[string]string

+ func (r *VarReader) Read(varName string, target interface{}) bool

+ func (r *VarReader) ReadRequired(varName string, target interface{}) bool

+ func (r *VarReader) ReadStruct(target interface{}, recursive bool)

+ func (r *VarReader) WithVarNamePrefix(prefix string) *VarReader

+ func (r *VarReader) WithVarNameSuffix(suffix string) *VarReader

+ func (r VarReader) Result() ValidationResult