config

Documentation

Index

• Constants
• Variables
• func Get(key string, out any) error
• func GetSection(section Section) error
• func Load(confFile string, overrides map[string]any) error
• func LoadMap(m map[string]any) error
• func LoadReader(reader io.Reader, overrides map[string]any) error
• type Defaulter
• type Section
• type Validator
• type Wrapper
  • func Global() *Wrapper
  • func WrapperFromMap(m map[string]any) (*Wrapper, error)
  • func WrapperFromReader(reader io.Reader, overrides map[string]any) (*Wrapper, error)
  • func (w *Wrapper) Get(key string, out any) error
  • func (w *Wrapper) GetSection(section Section) error

Constants

const DefaultMarker = "__default__"

Variables

var ErrConfigNotLoaded = errors.New("config not loaded")

Functions

func Get

func Get(key string, out any) error

Get populates out with the configuration at the given key. Populate out with default values before calling this function to ensure sane defaults if there are any.

func GetSection

func GetSection(section Section) error

GetSection populates a config section.

func Load

func Load(confFile string, overrides map[string]any) error

Load loads the config file at the given path.

func LoadMap

func LoadMap(m map[string]any) error

func LoadReader

func LoadReader(reader io.Reader, overrides map[string]any) error

Types

type Defaulter

type Defaulter interface {
	SetDefaults()
}

type Section

type Section interface {
	Key() string
}

type Validator

type Validator interface {
	Validate() error
}

type Wrapper

type Wrapper struct {
	// contains filtered or unexported fields
}

func Global

func Global() *Wrapper

Global returns the default global config wrapper.

func WrapperFromMap

func WrapperFromMap(m map[string]any) (*Wrapper, error)

func WrapperFromReader

func WrapperFromReader(reader io.Reader, overrides map[string]any) (*Wrapper, error)

func (*Wrapper) Get

func (w *Wrapper) Get(key string, out any) error

func (*Wrapper) GetSection

func (w *Wrapper) GetSection(section Section) error