README
¶
INI Parser
This is a parser for parse INI format content to golang data
Feature
- Support parse section, array value.
- Support comments start with
;# - Support multi line comments
/* .. */ - Support multi line value with
"""or'''
Install
go get github.com/gookit/ini/v2/parser
Usage
package main
import (
"github.com/gookit/goutil"
"github.com/gookit/goutil/dump"
"github.com/gookit/ini/v2/parser"
)
func main() {
p := parser.New()
err := p.ParseString(`
# comments 1
name = inhere
age = 28
; comments 2
[sec1]
key = val0
some = value
`)
goutil.PanicErr(err)
// dump parsed data and collected comments map
dump.P(p.ParsedData(), p.Comments())
}
Output:
map[string]map[string]string { #len=2
"__default": map[string]string { #len=7
"name": string("inhere"), #len=6
"age": string("28"), #len=2
},
"sec1": map[string]string { #len=3
"key": string("val0"), #len=4
"some": string("value"), #len=5
},
},
# collected comments
map[string]string { #len=2
"_sec_sec1": string("; comments 2"), #len=12
"__default_name": string("# comments 1"), #len=12
},
Functions API
func Decode(blob []byte, ptr any) error
func Encode(v any) ([]byte, error)
func EncodeFull(data map[string]any, defSection ...string) (out []byte, err error)
func EncodeLite(data map[string]map[string]string, defSection ...string) (out []byte, err error)
func EncodeSimple(data map[string]map[string]string, defSection ...string) ([]byte, error)
func EncodeWithDefName(v any, defSection ...string) (out []byte, err error)
func IgnoreCase(p *Parser)
func InlineComment(opt *Options)
func NoDefSection(p *Parser)
func WithReplaceNl(opt *Options)
type OptFunc func(opt *Options)
func WithDefSection(name string) OptFunc
func WithParseMode(mode parseMode) OptFunc
func WithTagName(name string) OptFunc
type Options struct{ ... }
func NewOptions(fns ...OptFunc) *Options
type Parser struct{ ... }
func New(fns ...OptFunc) *Parser
func NewFulled(fns ...func(*Parser)) *Parser
func NewLite(fns ...OptFunc) *Parser
func NewSimpled(fns ...func(*Parser)) *Parser
func Parse(data string, mode parseMode, opts ...func(*Parser)) (p *Parser, err error)
Related
- dombenson/go-ini ini parser and config manage
- go-ini/ini ini parser and config manage
License
MIT
Documentation
¶
Overview ¶
Package parser is a Parser for parse INI format content to golang data
There are example data:
# comments
name = inhere
age = 28
debug = true
hasQuota1 = 'this is val'
hasQuota2 = "this is val1"
shell = ${SHELL}
noEnv = ${NotExist|defValue}
; array in def section
tags[] = a
tags[] = b
tags[] = c
; comments
[sec1]
key = val0
some = value
stuff = things
; array in section
types[] = x
types[] = y
how to use, please see examples:
Index ¶
- Constants
- Variables
- func Decode(blob []byte, ptr any) error
- func Encode(v any) ([]byte, error)
- func EncodeFull(data map[string]any, defSection ...string) (out []byte, err error)
- func EncodeLite(data map[string]map[string]string, defSection ...string) (out []byte, err error)
- func EncodeSimple(data map[string]map[string]string, defSection ...string) ([]byte, error)
- func EncodeWithDefName(v any, defSection ...string) (out []byte, err error)
- func IgnoreCase(p *Parser)
- func InlineComment(opt *Options)
- func NoDefSection(p *Parser)
- func WithReplaceNl(opt *Options)
- type OptFunc
- type Options
- type Parser
- func (p *Parser) Comments() map[string]string
- func (p *Parser) Decode(ptr any) error
- func (p *Parser) FullData() map[string]any
- func (p *Parser) LiteData() map[string]map[string]string
- func (p *Parser) LiteSection(name string) map[string]string
- func (p *Parser) MapStruct(ptr any) (err error)
- func (p *Parser) ParseBytes(bts []byte) (err error)
- func (p *Parser) ParseFrom(in *bufio.Scanner) (count int64, err error)
- func (p *Parser) ParseReader(r io.Reader) (err error)
- func (p *Parser) ParseString(str string) error
- func (p *Parser) ParsedData() any
- func (p *Parser) Reset()
- func (p *Parser) SimpleData() map[string]map[string]string
- func (p *Parser) Unmarshal(v []byte, ptr any) error
- func (p *Parser) WithOptions(opts ...func(p *Parser)) *Parser
- type SectionMatcher
- type UserCollector
Examples ¶
Constants ¶
View Source
const ( ModeFull parseMode = 1 ModeLite parseMode = 2 ModeSimple parseMode = 2 // alias of ModeLite )
mode of parse data
ModeFull - will parse array value and inline array ModeLite/ModeSimple - don't parse array value line
View Source
const DefSection = "__default"
DefSection default section key name
View Source
const TokSection = textscan.TokComments + 1 + iota
TokSection for mark a section
Variables ¶
View Source
var TagName = "ini"
TagName default tag-name of mapping data to struct
Functions ¶
func EncodeFull ¶
EncodeFull full mode data to INI, can set default section name
func EncodeLite ¶ added in v2.1.3
EncodeLite data to INI
func EncodeSimple ¶
EncodeSimple data to INI
func EncodeWithDefName ¶ added in v2.1.2
EncodeWithDefName golang data(map, struct) to INI, can set default section name
func NoDefSection ¶
func NoDefSection(p *Parser)
NoDefSection set don't return DefSection title
Usage:
Parser.NoDefSection()
Types ¶
type OptFunc ¶ added in v2.1.3
type OptFunc func(opt *Options)
OptFunc define
func WithDefSection ¶ added in v2.1.3
WithDefSection name for parse
func WithParseMode ¶ added in v2.1.3
func WithParseMode(mode parseMode) OptFunc
WithParseMode name for parse
func WithTagName ¶ added in v2.1.3
WithTagName for decode data
type Options ¶ added in v2.1.3
type Options struct {
// TagName of mapping data to struct
TagName string
// ParseMode setting. default is ModeLite
ParseMode parseMode
// Ignore case for key name
IgnoreCase bool
// ReplaceNl replace the "\n" to newline
ReplaceNl bool
// default section name. default is "__default"
DefSection string
// NoDefSection setting. only for full parse mode
NoDefSection bool
// InlineComment support parse inline comments. default is false
InlineComment bool
// Collector allow you custom the value collector.
//
// Notice: in lite mode, isSlice always is false.
Collector UserCollector
}
Options for parser
type Parser ¶
type Parser struct {
*Options
// contains filtered or unexported fields
}
Parser definition
func NewFulled ¶
NewFulled create a full mode Parser with some options
Example ¶
p, err := Parse(iniStr, ModeFull)
// p, err := Parse(iniStr, ModeFull, NoDefSection)
if err != nil {
panic(err)
}
fmt.Printf("full parse:\n%#v\n", p.FullData())
Output:
func NewSimpled ¶
NewSimpled create a lite mode Parser
Example ¶
// simple mode will ignore all array values
p, err := Parse(iniStr, ModeSimple)
if err != nil {
panic(err)
}
fmt.Printf("simple parse:\n%#v\n", p.SimpleData())
Output:
func (*Parser) LiteSection ¶ added in v2.1.2
LiteSection get parsed data by simple parse
func (*Parser) ParseBytes ¶
ParseBytes parse from bytes data
func (*Parser) ParseReader ¶ added in v2.1.3
ParseReader parse from io reader
func (*Parser) ParseString ¶
ParseString parse from string data
func (*Parser) SimpleData ¶
SimpleData get parsed data by simple parse
func (*Parser) WithOptions ¶
WithOptions apply some options
type SectionMatcher ¶ added in v2.1.3
type SectionMatcher struct{}
SectionMatcher match section line: [section]
type UserCollector ¶
UserCollector custom data collector.
Notice: in lite mode, isSlice always is false.
Source Files
Click to show internal directories.
Click to hide internal directories.