cfg

Documentation

Index

• Variables
• func Parse(dst interface{}) error
• func Unmarshal(dst interface{}, sources ...Source) error
• type Source
  • func Defaults() Source
  • func Flags() Source
  • func JSON(f *string) Source
  • func YAML(f *string) Source
  • func YAMLFlag(name, value, help string) Source

Variables

var (
	ErrNotPointer = errors.New("dst is not a pointer")
)

Functions

func Parse

func Parse(dst interface{}) error

Parse is a higher level wrapper for Unmarshal that automatically parses flags and a .yaml file

func Unmarshal

func Unmarshal(dst interface{}, sources ...Source) error

Unmarshal merges the values of the various configuration sources and sets them on `dst`. The object must be compatible with `json.Unmarshal`.

Types

type Source

type Source func(interface{}) error

Source is a generic configuration source. This function may do whatever is required to obtain the configuration. It is passed a pointer to the destination, which will be something compatible to `json.Unmarshal`. The obtained configuration may be written to this object, it may also contain data from previous sources.

func Defaults

func Defaults() Source

Defaults registers flags to the command line using dst as the flagext.Registerer

func Flags

func Flags() Source

Flags parses the flag from the command line, setting only user-supplied values on the flagext.Registerer passed to Defaults()

func JSON

func JSON(f *string) Source

JSON returns a Source that opens the supplied `.json` file and loads it.

func YAML

func YAML(f *string) Source

YAML returns a Source that opens the supplied `.yaml` file and loads it.

func YAMLFlag

func YAMLFlag(name, value, help string) Source

YAMLFlag defines a `config.file` flag and loads this file