boa

Documentation

Index

• func AddFlags(r *pflag.FlagSet, config interface{}) error
• func BindEnv(r ConfigRegistry, config interface{}) error
• func DefaultDecodeHooks() []mapstructure.DecodeHookFunc
• func SetDefaults(r ConfigRegistry, config interface{}) error
• func StringToTCPAddrHookFunc() mapstructure.DecodeHookFunc
• func StringToUDPAddrHookFunc() mapstructure.DecodeHookFunc
• type ConfigRegistry
• type Pather
  • func (p Pather) CommandPath() string

Functions

func AddFlags

func AddFlags(r *pflag.FlagSet, config interface{}) error

AddFlags adds flags to the provided flag set based on the config struct. Default are set according to the values present in the config struct.

func BindEnv

func BindEnv(r ConfigRegistry, config interface{}) error

BindEnv binds the environemt variables based on the config struct.

func DefaultDecodeHooks

func DefaultDecodeHooks() []mapstructure.DecodeHookFunc

DefaultDecodeHooks returns a list of useful decoding hooks.

func SetDefaults

func SetDefaults(r ConfigRegistry, config interface{}) error

SetDefaults sets the default values based on the values contained in the provided config struct.

func StringToTCPAddrHookFunc

func StringToTCPAddrHookFunc() mapstructure.DecodeHookFunc

StringToTCPAddrHookFunc returns a DecodeHookFunc that converts strings to net.TCPAddr

func StringToUDPAddrHookFunc

func StringToUDPAddrHookFunc() mapstructure.DecodeHookFunc

StringToUDPAddrHookFunc returns a DecodeHookFunc that converts strings to net.UDPAddr

Types

type ConfigRegistry

type ConfigRegistry interface {
	BindEnv(input ...string) error
	SetDefault(key string, value interface{})
}

ConfigRegistry is an abstraction of viper.Viper.

type Pather

type Pather string

Pather wraps a string to implement the Pather interface.

func (Pather) CommandPath

func (p Pather) CommandPath() string

CommandPath returns the wrapped string