configparser

Documentation

Index

• Constants
• type Parser
  • func NewParser() *Parser
  • func NewParserFromBuffer(buf io.Reader) (*Parser, error)
  • func NewParserFromFile(fileName string) (*Parser, error)
  • func NewParserFromStringMap(data map[string]interface{}) *Parser
  • func (l *Parser) AllKeys() []string
  • func (l *Parser) Get(key string) interface{}
  • func (l *Parser) IsSet(key string) bool
  • func (l *Parser) MergeStringMap(cfg map[string]interface{}) error
  • func (l *Parser) Set(key string, value interface{})
  • func (l *Parser) Sub(key string) (*Parser, error)
  • func (l *Parser) ToStringMap() map[string]interface{}
  • func (l *Parser) Unmarshal(rawVal interface{}) error
  • func (l *Parser) UnmarshalExact(intoCfg interface{}) error

Constants

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

Types

type Parser

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

Parser loads configuration.

func NewParser

func NewParser() *Parser

NewParser creates a new empty Parser instance.

func NewParserFromBuffer

func NewParserFromBuffer(buf io.Reader) (*Parser, error)

NewParserFromBuffer creates a new Parser by reading the given yaml buffer.

func NewParserFromFile

func NewParserFromFile(fileName string) (*Parser, error)

NewParserFromFile creates a new Parser by reading the given file.

func NewParserFromStringMap

func NewParserFromStringMap(data map[string]interface{}) *Parser

NewParserFromStringMap creates a parser from a map[string]interface{}.

func (*Parser) AllKeys

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

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

func (*Parser) Get

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

Get can retrieve any value given the key to use.

func (*Parser) IsSet

func (l *Parser) 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 (*Parser) MergeStringMap

func (l *Parser) 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 (*Parser) Set

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

Set sets the value for the key.

func (*Parser) Sub

func (l *Parser) Sub(key string) (*Parser, 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 (*Parser) ToStringMap

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

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

func (*Parser) Unmarshal

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

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

func (*Parser) UnmarshalExact

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

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