iniconf

package

v1.7.4 Latest Latest Go to latest Published: Aug 28, 2023 License: BSD-2-Clause, ISC Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var DefaultSection = "default"

DefaultSection is the label for the default ini file section.

This section is empty.

type ConfigMap map[string]map[string]string

ConfigMap is shorthand for the type used as a config struct.

func ParseFile(fileName string) (cfg ConfigMap, err error)

ParseFile attempts to load the named config file.

func ParseReader(r io.Reader) (cfg ConfigMap, err error)

ParseReader reads a configuration from an io.Reader.

func (c ConfigMap) AddKeyVal(section, key, val string)

AddKeyVal adds a key value pair to a config map.

func (c ConfigMap) AddSection(section string)

AddSection creates a new section in the config map.

func (c ConfigMap) GetValue(section, key string) (val string, present bool)

GetValue retrieves the value from a key map.

func (c ConfigMap) GetValueDefault(section, key, value string) (val string)

GetValueDefault retrieves the value from a key map if present, otherwise the default value.

func (c ConfigMap) ListSections() (sections []string)

ListSections returns the list of sections in the config map.

func (c ConfigMap) SectionInConfig(section string) bool

SectionInConfig determines whether a section is in the configuration.

func (c ConfigMap) SectionKeys(section string) (keys []string, present bool)

SectionKeys returns the sections in the config map.

func (c ConfigMap) WriteFile(filename string) (err error)

WriteFile writes out the configuration to a file.