config

Documentation

Index

• Variables
• func Get(key string, out interface{}) error
• func GetSection(section Section) error
• func Load(confFile string, overrides map[string]interface{}) error
• func LoadAndWatch(ctx context.Context, confFile string, overrides map[string]interface{}) error
• func LoadMap(m map[string]interface{}) error
• func LoadReader(reader io.Reader) error
• type Defaulter
• type Section
• type Validator

Variables

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

Functions

func Get

func Get(key string, out interface{}) 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]interface{}) error

Load loads the config file at the given path.

func LoadAndWatch

func LoadAndWatch(ctx context.Context, confFile string, overrides map[string]interface{}) error

LoadAndWatch automatically reloads configuration if the config file changes.

func LoadMap

func LoadMap(m map[string]interface{}) error

func LoadReader

func LoadReader(reader io.Reader) error

Types

type Defaulter

type Defaulter interface {
	SetDefaults()
}

type Section

type Section interface {
	Key() string
}

type Validator

type Validator interface {
	Validate() error
}