README ¶
go-ini
INI parsing library for Go (golang).
View the API documentation here.
Usage
Parse an INI file:
import "github.com/vaughan0/go-ini"
file, err := ini.LoadFile("myfile.ini")
Get data from the parsed file:
name, ok := file.Get("person", "name")
if !ok {
panic("'name' variable missing from 'person' section")
}
Iterate through values in a section:
for key, value := range file["mysection"] {
fmt.Printf("%s => %s\n", key, value)
}
Iterate through sections in a file:
for name, section := range file {
fmt.Printf("Section name: %s\n", name)
}
File Format
INI files are parsed by go-ini line-by-line. Each line may be one of the following:
- A section definition: [section-name]
- A property: key = value
- A comment: #blahblah or ;blahblah
- Blank. The line will be ignored.
Properties defined before any section headers are placed in the default section, which has the empty string as it's key.
Example:
# I am a comment
; So am I!
[apples]
colour = red or green
shape = applish
[oranges]
shape = square
colour = blue
Documentation ¶
Overview ¶
Package ini provides functions for parsing INI configuration files.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrSyntax ¶
type ErrSyntax struct { Line int Source string // The contents of the erroneous line, without leading or trailing whitespace }
ErrSyntax is returned when there is a syntax error in an INI file.
type File ¶
A File represents a parsed INI file.
func (File) Get ¶
Looks up a value for a key in a section and returns that value, along with a boolean result similar to a map lookup.