envconf

Documentation

Index

• type Config
  • func NewConfig() *Config
  • func (c *Config) Define(key string, dtype DataType)
  • func (c *Config) DefineDefault(key string, val string, dtype DataType)
  • func (c *Config) DefineMap(key string, dtype DataType)
  • func (c *Config) GetBool(key string) bool
  • func (c *Config) GetDirectory(key string) string
  • func (c *Config) GetDuration(key string) time.Duration
  • func (c *Config) GetHex(key string) []byte
  • func (c *Config) GetInt(key string) int64
  • func (c *Config) GetMapBool(key string) (empty map[string]bool)
  • func (c *Config) GetMapDirectory(key string) (empty map[string]string)
  • func (c *Config) GetMapDuration(key string) (empty map[string]time.Duration)
  • func (c *Config) GetMapHex(key string) (empty map[string][]byte)
  • func (c *Config) GetMapInt(key string) (empty map[string]int64)
  • func (c *Config) GetMapMapBool(key string) (empty map[string]map[string]bool)
  • func (c *Config) GetMapMapDirectory(key string) (empty map[string]map[string]string)
  • func (c *Config) GetMapMapDuration(key string) (empty map[string]map[string]time.Duration)
  • func (c *Config) GetMapMapHex(key string) (empty map[string]map[string][]byte)
  • func (c *Config) GetMapMapInt(key string) (empty map[string]map[string]int64)
  • func (c *Config) GetMapMapMapBool(key string) (empty map[string]map[string]map[string]bool)
  • func (c *Config) GetMapMapMapDirectory(key string) (empty map[string]map[string]map[string]string)
  • func (c *Config) GetMapMapMapDuration(key string) (empty map[string]map[string]map[string]time.Duration)
  • func (c *Config) GetMapMapMapHex(key string) (empty map[string]map[string]map[string][]byte)
  • func (c *Config) GetMapMapMapInt(key string) (empty map[string]map[string]map[string]int64)
  • func (c *Config) GetMapMapMapMapBool(key string) (empty map[string]map[string]map[string]map[string]bool)
  • func (c *Config) GetMapMapMapMapDirectory(key string) (empty map[string]map[string]map[string]map[string]string)
  • func (c *Config) GetMapMapMapMapDuration(key string) (empty map[string]map[string]map[string]map[string]time.Duration)
  • func (c *Config) GetMapMapMapMapHex(key string) (empty map[string]map[string]map[string]map[string][]byte)
  • func (c *Config) GetMapMapMapMapInt(key string) (empty map[string]map[string]map[string]map[string]int64)
  • func (c *Config) GetMapMapMapMapMapBool(key string) (empty map[string]map[string]map[string]map[string]map[string]bool)
  • func (c *Config) GetMapMapMapMapMapDirectory(key string) (empty map[string]map[string]map[string]map[string]map[string]string)
  • func (c *Config) GetMapMapMapMapMapDuration(key string) (empty map[string]map[string]map[string]map[string]map[string]time.Duration)
  • func (c *Config) GetMapMapMapMapMapHex(key string) (empty map[string]map[string]map[string]map[string]map[string][]byte)
  • func (c *Config) GetMapMapMapMapMapInt(key string) (empty map[string]map[string]map[string]map[string]map[string]int64)
  • func (c *Config) GetMapMapMapMapMapMetric(key string) (empty map[string]map[string]map[string]map[string]map[string]int64)
  • func (c *Config) GetMapMapMapMapMapString(key string) (empty map[string]map[string]map[string]map[string]map[string]string)
  • func (c *Config) GetMapMapMapMapMetric(key string) (empty map[string]map[string]map[string]map[string]int64)
  • func (c *Config) GetMapMapMapMapString(key string) (empty map[string]map[string]map[string]map[string]string)
  • func (c *Config) GetMapMapMapMetric(key string) (empty map[string]map[string]map[string]int64)
  • func (c *Config) GetMapMapMapString(key string) (empty map[string]map[string]map[string]string)
  • func (c *Config) GetMapMapMetric(key string) (empty map[string]map[string]int64)
  • func (c *Config) GetMapMapString(key string) (empty map[string]map[string]string)
  • func (c *Config) GetMapMetric(key string) (empty map[string]int64)
  • func (c *Config) GetMapString(key string) (empty map[string]string)
  • func (c *Config) GetMetric(key string) int64
  • func (c *Config) GetString(key string) string
  • func (c *Config) Parse()
  • func (c *Config) Status() (ok bool)
  • func (c *Config) StatusHelp() bool
• type DataType
  • func FixedHex(size uint16) DataType
  • func (dtype DataType) String() string

Types

type Config

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

func NewConfig

func NewConfig() *Config

NewConfig returns an envconf.Config that is used to read configuration from environment variables. The environment variables are stored in envconf.Config, so changes to the environment after NewConfig has been called will not be taken into account.

func (*Config) Define

func (c *Config) Define(key string, dtype DataType)

Define the type of an environment variable. Variables without a defined type will be ignored by Parse.

func (*Config) DefineDefault

func (c *Config) DefineDefault(key string, val string, dtype DataType)

Define the type and default value of an environment variable. Variables without a defined type will be ignored by Parse.

func (*Config) DefineMap

func (c *Config) DefineMap(key string, dtype DataType)

Define the type of an environment variable. Variables without a defined type will be ignored by Parse.

func (*Config) GetBool

func (c *Config) GetBool(key string) bool

Returns the value of an environment variable. If the variable is not defined as envconf.TypeBool the function will return false.

func (*Config) GetDirectory

func (c *Config) GetDirectory(key string) string

Returns the value of an environment variable. If the variable is not defined as envconf.TypeDirectory the function will return the empty string.

func (*Config) GetDuration

func (c *Config) GetDuration(key string) time.Duration

Returns the value of an environment variable. If the variable is not defined as envconf.TypeDuration the function will return time.Duration(0).

func (*Config) GetHex

func (c *Config) GetHex(key string) []byte

Returns the value of an environment variable. If the variable is not defined as envconf.TypeHex the function will return []byte{}.

func (*Config) GetInt

func (c *Config) GetInt(key string) int64

Returns the value of an environment variable. If the variable is not defined as envconf.TypeInt the function will return 0.

func (*Config) GetMapBool

func (c *Config) GetMapBool(key string) (empty map[string]bool)

func (*Config) GetMapDirectory

func (c *Config) GetMapDirectory(key string) (empty map[string]string)

func (*Config) GetMapDuration

func (c *Config) GetMapDuration(key string) (empty map[string]time.Duration)

func (*Config) GetMapHex

func (c *Config) GetMapHex(key string) (empty map[string][]byte)

func (*Config) GetMapInt

func (c *Config) GetMapInt(key string) (empty map[string]int64)

func (*Config) GetMapMapBool

func (c *Config) GetMapMapBool(key string) (empty map[string]map[string]bool)

func (*Config) GetMapMapDirectory

func (c *Config) GetMapMapDirectory(key string) (empty map[string]map[string]string)

func (*Config) GetMapMapDuration

func (c *Config) GetMapMapDuration(key string) (empty map[string]map[string]time.Duration)

func (*Config) GetMapMapHex

func (c *Config) GetMapMapHex(key string) (empty map[string]map[string][]byte)

func (*Config) GetMapMapInt

func (c *Config) GetMapMapInt(key string) (empty map[string]map[string]int64)

func (*Config) GetMapMapMapBool

func (c *Config) GetMapMapMapBool(key string) (empty map[string]map[string]map[string]bool)

func (*Config) GetMapMapMapDirectory

func (c *Config) GetMapMapMapDirectory(key string) (empty map[string]map[string]map[string]string)

func (*Config) GetMapMapMapDuration

func (c *Config) GetMapMapMapDuration(key string) (empty map[string]map[string]map[string]time.Duration)

func (*Config) GetMapMapMapHex

func (c *Config) GetMapMapMapHex(key string) (empty map[string]map[string]map[string][]byte)

func (*Config) GetMapMapMapInt

func (c *Config) GetMapMapMapInt(key string) (empty map[string]map[string]map[string]int64)

func (*Config) GetMapMapMapMapBool

func (c *Config) GetMapMapMapMapBool(key string) (empty map[string]map[string]map[string]map[string]bool)

func (*Config) GetMapMapMapMapDirectory

func (c *Config) GetMapMapMapMapDirectory(key string) (empty map[string]map[string]map[string]map[string]string)

func (*Config) GetMapMapMapMapDuration

func (c *Config) GetMapMapMapMapDuration(key string) (empty map[string]map[string]map[string]map[string]time.Duration)

func (*Config) GetMapMapMapMapHex

func (c *Config) GetMapMapMapMapHex(key string) (empty map[string]map[string]map[string]map[string][]byte)

func (*Config) GetMapMapMapMapInt

func (c *Config) GetMapMapMapMapInt(key string) (empty map[string]map[string]map[string]map[string]int64)

func (*Config) GetMapMapMapMapMapBool

func (c *Config) GetMapMapMapMapMapBool(key string) (empty map[string]map[string]map[string]map[string]map[string]bool)

func (*Config) GetMapMapMapMapMapDirectory

func (c *Config) GetMapMapMapMapMapDirectory(key string) (empty map[string]map[string]map[string]map[string]map[string]string)

func (*Config) GetMapMapMapMapMapDuration

func (c *Config) GetMapMapMapMapMapDuration(key string) (empty map[string]map[string]map[string]map[string]map[string]time.Duration)

func (*Config) GetMapMapMapMapMapHex

func (c *Config) GetMapMapMapMapMapHex(key string) (empty map[string]map[string]map[string]map[string]map[string][]byte)

func (*Config) GetMapMapMapMapMapInt

func (c *Config) GetMapMapMapMapMapInt(key string) (empty map[string]map[string]map[string]map[string]map[string]int64)

func (*Config) GetMapMapMapMapMapMetric

func (c *Config) GetMapMapMapMapMapMetric(key string) (empty map[string]map[string]map[string]map[string]map[string]int64)

func (*Config) GetMapMapMapMapMapString

func (c *Config) GetMapMapMapMapMapString(key string) (empty map[string]map[string]map[string]map[string]map[string]string)

func (*Config) GetMapMapMapMapMetric

func (c *Config) GetMapMapMapMapMetric(key string) (empty map[string]map[string]map[string]map[string]int64)

func (*Config) GetMapMapMapMapString

func (c *Config) GetMapMapMapMapString(key string) (empty map[string]map[string]map[string]map[string]string)

func (*Config) GetMapMapMapMetric

func (c *Config) GetMapMapMapMetric(key string) (empty map[string]map[string]map[string]int64)

func (*Config) GetMapMapMapString

func (c *Config) GetMapMapMapString(key string) (empty map[string]map[string]map[string]string)

func (*Config) GetMapMapMetric

func (c *Config) GetMapMapMetric(key string) (empty map[string]map[string]int64)

func (*Config) GetMapMapString

func (c *Config) GetMapMapString(key string) (empty map[string]map[string]string)

func (*Config) GetMapMetric

func (c *Config) GetMapMetric(key string) (empty map[string]int64)

func (*Config) GetMapString

func (c *Config) GetMapString(key string) (empty map[string]string)

func (*Config) GetMetric

func (c *Config) GetMetric(key string) int64

Returns the value of an environment variable. If the variable is not defined as envconf.TypeMetric the function will return 0.

func (*Config) GetString

func (c *Config) GetString(key string) string

Returns the value of an environment variable. If the variable is not defined as envconf.TypeString the function will return the empty string.

func (*Config) Parse

func (c *Config) Parse()

Parse parses the environment variables previously defined by Define and DefineDefault. Parse should only be called once for a given envconf.Config.

func (*Config) Status

func (c *Config) Status() (ok bool)

Status prints out failures that occured while parsing the environment to os.Stderr. Variables that have been defined without a default value and are missing from the environment will be considered a failure. If parsing of any of the variables has failed Status will return false.

func (*Config) StatusHelp

func (c *Config) StatusHelp() bool

type DataType

type DataType uint32

const (
	TypeNone      DataType = iota << 16
	TypeInt       DataType = iota << 16
	TypeMetric    DataType = iota << 16
	TypeDuration  DataType = iota << 16
	TypeString    DataType = iota << 16
	TypeDirectory DataType = iota << 16
	TypeBool      DataType = iota << 16
	TypeHex       DataType = iota << 16
)

func FixedHex

func FixedHex(size uint16) DataType

func (DataType) String

func (dtype DataType) String() string