conf

Documentation

Index

• func Init()
• func KeyMap() map[string]interface{}
• func OnChange(cb func(*Config))
• func Unmarshal(key string, object interface{}) error
• type Config
  • func New() *Config
  • func (c *Config) GetKeyMap() map[string]interface{}
  • func (c *Config) Keys() []string
  • func (c *Config) Load(provider Provider, parser Parser) error
  • func (c *Config) OnChange(cb func(*Config))
  • func (c *Config) Print() string
  • func (c *Config) SetDelimiter(delimiter string)
  • func (c *Config) Unmarshal(key string, object interface{}) error
• type Parser
• type Provider

Functions

func Init

func Init()

func KeyMap

func KeyMap() map[string]interface{}

func OnChange

func OnChange(cb func(*Config))

func Unmarshal

func Unmarshal(key string, object interface{}) error

Types

type Config

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

func New

func New() *Config

func (*Config) GetKeyMap

func (c *Config) GetKeyMap() map[string]interface{}

func (*Config) Keys

func (c *Config) Keys() []string

Keys returns the slice of all flattened keys in the loaded configuration sorted alphabetically.

func (*Config) Load

func (c *Config) Load(provider Provider, parser Parser) error

Load takes a Provider that either provides a parsed config map[string]interface{} in which case pa (Parser) can be nil, or raw bytes to be parsed, where a Parser can be provided to parse.

func (*Config) OnChange

func (c *Config) OnChange(cb func(*Config))

func (*Config) Print

func (c *Config) Print() string

Print prints a key -> value string representation of the config map with keys sorted alphabetically.

func (*Config) SetDelimiter

func (c *Config) SetDelimiter(delimiter string)

func (*Config) Unmarshal

func (c *Config) Unmarshal(key string, object interface{}) error

Unmarshal unmarshals a given key path into the given struct using the mapstructure lib. If no path is specified, the whole map is unmarshalled. `conf` is the struct field tag used to match field names.

type Parser

type Parser interface {
	Marshal(map[string]interface{}) ([]byte, error)
	Unmarshal([]byte) (map[string]interface{}, error)
}

type Provider

type Provider interface {
	ReadBytes() ([]byte, error)
	Watch(func()) error
}