strongParser

Documentation

Index

• func GetDefaultValue(kind reflect.Kind) any
• func GetPointerKind(t reflect.Type) reflect.Kind
• func ParseByteConfig(value interface{}, b []byte) error
• func ParseConfig(value interface{}, filename string) error
• func ParseStringConfig(value interface{}, strValue string) error
• func SetDefaultValue(field reflect.Value, kind reflect.Kind)
• type ChainMap
  • func NewChainMap(dicts ...Dict) *ChainMap
  • func (c *ChainMap) Get(key string) string
  • func (c *ChainMap) Len() int
• type Config
• type ConfigParser
  • func NewConfigParser() *ConfigParser
  • func NewConfigParserFromFile(filename string) (*ConfigParser, error)
  • func NewWithDefaults(defaults Dict) *ConfigParser
  • func Parse(filename string) (*ConfigParser, error)
  • func ParseBytes(b []byte) (*ConfigParser, error)
  • func ParseString(value string) (*ConfigParser, error)
  • func (p *ConfigParser) Defaults() Dict
  • func (p *ConfigParser) Get(section, option string) (string, error)
  • func (p *ConfigParser) GetBool(section, option string) (bool, error)
  • func (p *ConfigParser) GetComplex128(section, option string) (complex128, error)
  • func (p *ConfigParser) GetFloat64(section, option string) (float64, error)
  • func (p *ConfigParser) GetInt64(section, option string) (int64, error)
  • func (p *ConfigParser) GetIntSlice(section, option string) ([]int64, error)
  • func (p *ConfigParser) GetRune(section, option string) rune
  • func (p *ConfigParser) GetStringSlice(section, option string) ([]string, error)
  • func (p *ConfigParser) HasOption(section, option string) (bool, error)
  • func (p *ConfigParser) HasSection(section string) bool
  • func (p *ConfigParser) Items(section string) (Dict, error)
  • func (p *ConfigParser) ItemsWithDefaults(section string) (Dict, error)
  • func (p *ConfigParser) Options(section string) ([]string, error)
  • func (p *ConfigParser) RemoveOption(section, option string) error
  • func (p *ConfigParser) Sections() []string
  • func (p *ConfigParser) Set(section, option, value string) error
• type Dict
  • func (d Dict) Keys() []string
• type InvalidParseError
  • func (e *InvalidParseError) Error() string
• type Section
  • func (s *Section) Add(key, value string) error
  • func (s *Section) Get(key string) (string, error)
  • func (s *Section) Items() Dict
  • func (s *Section) Options() []string
  • func (s *Section) Remove(key string) error

Functions

func GetDefaultValue

func GetDefaultValue(kind reflect.Kind) any

func GetPointerKind

func GetPointerKind(t reflect.Type) reflect.Kind

func ParseByteConfig

func ParseByteConfig(value interface{}, b []byte) error

func ParseConfig

func ParseConfig(value interface{}, filename string) error

func ParseStringConfig

func ParseStringConfig(value interface{}, strValue string) error

func SetDefaultValue

func SetDefaultValue(field reflect.Value, kind reflect.Kind)

Types

type ChainMap

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

func NewChainMap

func NewChainMap(dicts ...Dict) *ChainMap

func (*ChainMap) Get

func (c *ChainMap) Get(key string) string

func (*ChainMap) Len

func (c *ChainMap) Len() int

type Config

type Config map[string]*Section

Config represents a Python style configuration file.

type ConfigParser

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

ConfigParser ties together a Config and default values for use in interpolated configuration values.

func NewConfigParser

func NewConfigParser() *ConfigParser

New creates a new ConfigParser.

func NewConfigParserFromFile

func NewConfigParserFromFile(filename string) (*ConfigParser, error)

NewConfigParserFromFile creates a new ConfigParser struct populated from the supplied filename.

func NewWithDefaults

func NewWithDefaults(defaults Dict) *ConfigParser

NewWithDefaults allows creation of a new ConfigParser with a pre-existing Dict.

func Parse

func Parse(filename string) (*ConfigParser, error)

Parse takes a filename and parses it into a ConfigParser value.

func ParseBytes

func ParseBytes(b []byte) (*ConfigParser, error)

ParseBytes takes bytes array and parses it into a ConfigParser value.

func ParseString

func ParseString(value string) (*ConfigParser, error)

ParseBytes takes bytes array and parses it into a ConfigParser value.

func (*ConfigParser) Defaults

func (p *ConfigParser) Defaults() Dict

Defaults returns the items in the map used for default values.

func (*ConfigParser) Get

func (p *ConfigParser) Get(section, option string) (string, error)

Get returns string value for the named option.

Returns an error if a section does not exist Returns an error if the option does not exist either in the section or in the defaults

func (*ConfigParser) GetBool

func (p *ConfigParser) GetBool(section, option string) (bool, error)

func (*ConfigParser) GetComplex128

func (p *ConfigParser) GetComplex128(section, option string) (complex128, error)

func (*ConfigParser) GetFloat64

func (p *ConfigParser) GetFloat64(section, option string) (float64, error)

func (*ConfigParser) GetInt64

func (p *ConfigParser) GetInt64(section, option string) (int64, error)

func (*ConfigParser) GetIntSlice

func (p *ConfigParser) GetIntSlice(section, option string) ([]int64, error)

func (*ConfigParser) GetRune

func (p *ConfigParser) GetRune(section, option string) rune

func (*ConfigParser) GetStringSlice

func (p *ConfigParser) GetStringSlice(section, option string) ([]string, error)

func (*ConfigParser) HasOption

func (p *ConfigParser) HasOption(section, option string) (bool, error)

func (*ConfigParser) HasSection

func (p *ConfigParser) HasSection(section string) bool

HasSection returns true if the named section is present in the configuration.

The DEFAULT section is not acknowledged.

func (*ConfigParser) Items

func (p *ConfigParser) Items(section string) (Dict, error)

Items returns a copy of the section Dict not including the Defaults.

NOTE: This is different from the Python version which returns a list of tuples

func (*ConfigParser) ItemsWithDefaults

func (p *ConfigParser) ItemsWithDefaults(section string) (Dict, error)

ItemsWithDefaults returns a copy of the named section Dict including any values from the Defaults.

NOTE: This is different from the Python version which returns a list of tuples

func (*ConfigParser) Options

func (p *ConfigParser) Options(section string) ([]string, error)

Options returns a list of option names for the given section name.

Returns an error if the section does not exist.

func (*ConfigParser) RemoveOption

func (p *ConfigParser) RemoveOption(section, option string) error

func (*ConfigParser) Sections

func (p *ConfigParser) Sections() []string

Sections returns a list of section names, excluding [DEFAULT].

func (*ConfigParser) Set

func (p *ConfigParser) Set(section, option, value string) error

Set puts the given option into the named section.

Returns an error if the section does not exist.

type Dict

type Dict map[string]string

Dict is a simple string->string map.

func (Dict) Keys

func (d Dict) Keys() []string

Keys returns a sorted slice of keys

type InvalidParseError

type InvalidParseError struct {
	Type reflect.Type
}

InvalidParseError describes an invalid argument passed to ParseConfig. (The argument to ParseConfig must be a non-nil pointer.)

func (*InvalidParseError) Error

func (e *InvalidParseError) Error() string

type Section

type Section struct {
	Name string
	// contains filtered or unexported fields
}

func (*Section) Add

func (s *Section) Add(key, value string) error

func (*Section) Get

func (s *Section) Get(key string) (string, error)

func (*Section) Items

func (s *Section) Items() Dict

func (*Section) Options

func (s *Section) Options() []string

func (*Section) Remove

func (s *Section) Remove(key string) error