configparser

Documentation

Index

• Constants
• type ConfigMap
  • func NewConfigMap() *ConfigMap
  • func NewConfigMapFromBuffer(buf io.Reader) (*ConfigMap, error)
  • func NewConfigMapFromFile(fileName string) (*ConfigMap, error)
  • func NewConfigMapFromStringMap(data map[string]interface{}) *ConfigMap
  • func (l *ConfigMap) AllKeys() []string
  • func (l *ConfigMap) Get(key string) interface{}
  • func (l *ConfigMap) IsSet(key string) bool
  • func (l *ConfigMap) MergeStringMap(cfg map[string]interface{}) error
  • func (l *ConfigMap) Set(key string, value interface{})
  • func (l *ConfigMap) Sub(key string) (*ConfigMap, error)
  • func (l *ConfigMap) ToStringMap() map[string]interface{}
  • func (l *ConfigMap) Unmarshal(rawVal interface{}) error
  • func (l *ConfigMap) UnmarshalExact(intoCfg interface{}) error

Constants

const (
	// KeyDelimiter is used as the default key delimiter in the default koanf instance.
	KeyDelimiter = "::"
)

Types

type ConfigMap

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

ConfigMap loads configuration.

func NewConfigMap

func NewConfigMap() *ConfigMap

NewConfigMap creates a new empty ConfigMap instance.

func NewConfigMapFromBuffer

func NewConfigMapFromBuffer(buf io.Reader) (*ConfigMap, error)

NewConfigMapFromBuffer creates a new ConfigMap by reading the given yaml buffer.

func NewConfigMapFromFile

func NewConfigMapFromFile(fileName string) (*ConfigMap, error)

NewConfigMapFromFile creates a new ConfigMap by reading the given file.

func NewConfigMapFromStringMap

func NewConfigMapFromStringMap(data map[string]interface{}) *ConfigMap

NewConfigMapFromStringMap creates a ConfigMap from a map[string]interface{}.

func (*ConfigMap) AllKeys

func (l *ConfigMap) AllKeys() []string

AllKeys returns all keys holding a value, regardless of where they are set. Nested keys are returned with a KeyDelimiter separator.

func (*ConfigMap) Get

func (l *ConfigMap) Get(key string) interface{}

Get can retrieve any value given the key to use.

func (*ConfigMap) IsSet

func (l *ConfigMap) IsSet(key string) bool

IsSet checks to see if the key has been set in any of the data locations. IsSet is case-insensitive for a key.

func (*ConfigMap) MergeStringMap

func (l *ConfigMap) MergeStringMap(cfg map[string]interface{}) error

MergeStringMap merges the configuration from the given map with the existing config. Note that the given map may be modified.

func (*ConfigMap) Set

func (l *ConfigMap) Set(key string, value interface{})

Set sets the value for the key.

func (*ConfigMap) Sub

func (l *ConfigMap) Sub(key string) (*ConfigMap, error)

Sub returns new Parser instance representing a sub-config of this instance. It returns an error is the sub-config is not a map (use Get()) and an empty Parser if none exists.

func (*ConfigMap) ToStringMap

func (l *ConfigMap) ToStringMap() map[string]interface{}

ToStringMap creates a map[string]interface{} from a Parser.

func (*ConfigMap) Unmarshal

func (l *ConfigMap) Unmarshal(rawVal interface{}) error

Unmarshal unmarshalls the config into a struct. Tags on the fields of the structure must be properly set.

func (*ConfigMap) UnmarshalExact

func (l *ConfigMap) UnmarshalExact(intoCfg interface{}) error

UnmarshalExact unmarshalls the config into a struct, erroring if a field is nonexistent.