cfg

Documentation

Overview

package cfg implements functionalites for configuration

Index

• type Config
  • func (c *Config) GetConfig(dotDelimitedKey string) (conf Config, err error)
  • func (c *Config) GetValue(dotDelimitedKey string) interface{}
  • func (c *Config) Merge(overrides *Config) error
  • func (c *Config) ReadFrom(i interface{}) (err error)
  • func (c *Config) ReadFromToml(r io.Reader) (err error)
  • func (c *Config) ReadFromTomlBytes(b []byte) (err error)
  • func (c *Config) ReadFromTomlFile(file string) (err error)
  • func (c *Config) SetKeyValue(dotDelimitedKey string, v interface{})
  • func (c *Config) WriteTo(v interface{}) (err error)
  • func (c *Config) WriteToKVList(w io.Writer)
  • func (c *Config) WriteToToml(w io.Writer) (err error)

Types

type Config

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

Note: It is not thread/goroutine safe, and is intended to be used in places where it is goroutine/thread safety

func (*Config) GetConfig

func (c *Config) GetConfig(dotDelimitedKey string) (conf Config, err error)

GetConfig returns the config properties of a given key

func (*Config) GetValue

func (c *Config) GetValue(dotDelimitedKey string) interface{}

GetValue returns the assiciated value of the given dot-delimited key

func (*Config) Merge

func (c *Config) Merge(overrides *Config) error

Merge merges the properties from another Config When merging the properties, the keys are considered as case insensitive. The value for the same key will be overriden

func (*Config) ReadFrom

func (c *Config) ReadFrom(i interface{}) (err error)

ReadFrom reads configuration properties i, which pointing to a struct or a map

func (*Config) ReadFromToml

func (c *Config) ReadFromToml(r io.Reader) (err error)

ReadFromToml reads configuration properties in TOML format

func (*Config) ReadFromTomlBytes

func (c *Config) ReadFromTomlBytes(b []byte) (err error)

ReadFromTomlBytes reads configuration properties from byte array in TOML format

func (*Config) ReadFromTomlFile

func (c *Config) ReadFromTomlFile(file string) (err error)

ReadFromTomlFile reads configuration properties from a file in TOML format

func (*Config) SetKeyValue

func (c *Config) SetKeyValue(dotDelimitedKey string, v interface{})

SetKeyValue sets the value of a given key

func (*Config) WriteTo

func (c *Config) WriteTo(v interface{}) (err error)

WriteTo writes the configuration properties to a struct or map

func (*Config) WriteToKVList

func (c *Config) WriteToKVList(w io.Writer)

WriteToKVList writes the configuration properties as a dot-delimited-key value list

func (*Config) WriteToToml

func (c *Config) WriteToToml(w io.Writer) (err error)

WriteToToml writes the configuration properties in TOML format