conf

README

conf

conf file loader

Documentation

Index

• Variables
• func Load(name string, out interface{}) error
• type Decoder
  • func (f Decoder) Decode(buf []byte, out interface{}) error
• type Storage
  • func Dir(dir string) Storage
  • func Env(prefix string) Storage

Variables

var Decoders = map[string]Decoder{
	"JSON": {
		IDs: []string{"json"},
		ToJSON: func(content []byte) ([]byte, error) {
			return content, nil
		},
	},
	"YAML": {
		IDs: []string{"yml", "yaml"},
		ToJSON: func(content []byte) (bytes []byte, err error) {
			var m map[string]interface{}
			if err = yaml.Unmarshal(content, &m); err != nil {
				return
			}
			return json.Marshal(m)
		},
	},
	"TOML": {
		IDs: []string{"toml"},
		ToJSON: func(content []byte) (out []byte, err error) {
			var m map[string]interface{}
			if err = toml.Unmarshal(content, &m); err != nil {
				return
			}
			return json.Marshal(m)
		},
	},
}

var DefaultStorage = Dir("conf")

DefaultStorage default conf storage, from "conf" directory

Functions

func Load

func Load(name string, out interface{}) error

Load shortcut to DefaultStorage.Load

Types

type Decoder

type Decoder struct {
	IDs    []string
	ToJSON func(content []byte) (out []byte, err error)
}

func (Decoder) Decode

func (f Decoder) Decode(buf []byte, out interface{}) error

type Storage

type Storage interface {
	// Load load specified configuration into interface, tag 'json' and 'default' are supported
	Load(name string, out interface{}) error
}

Storage configuration storage, could be a local directory, a etcd endpoint or something else

func Dir

func Dir(dir string) Storage

Dir create a configuration storage from local directory

func Env

func Env(prefix string) Storage

Env create a configuration storage from env prefix