config

Documentation

Index

• Constants
• func UnmarshalKey[T any](cfg Configurer, key string) (value T, err error)
• func UnmarshalKeyE[T any](cfg Configurer, key string) (value T, err error)
• type Configurer
  • func NewConfigurer(cfgFile, prefix string) Configurer

Constants

const (
	OpUnmarshalKey errs.Op = "configurer: unmarshal key"
	OpUnmarshal    errs.Op = "configurer: unmarshal"
	OpOverwrite    errs.Op = "configurer: overwrite"
)

Functions

func UnmarshalKey

func UnmarshalKey[T any](cfg Configurer, key string) (value T, err error)

func UnmarshalKeyE

func UnmarshalKeyE[T any](cfg Configurer, key string) (value T, err error)

Types

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out any) error

	// Unmarshal the config into a Struct. Make sure that the tags
	// on the fields of the structure are properly set.
	Unmarshal(out any) error

	// Overwrite used to overwrite particular values in the unmarshalled config
	Overwrite(values map[string]any) error

	// Get used to get config section
	Get(name string) any

	// Has checks if config section exists.
	Has(name string) bool
}

func NewConfigurer

func NewConfigurer(cfgFile, prefix string) Configurer