README
¶
cfg
-- import "github.com/cmcoffee/go-snuglib/cfg"
Package 'cfg' provides functions for reading and writing configuration files and their coresponding string values.
Ignores '#' as comments, ','s denote multiple values.
# Example config file.
[section]
key = value
key2 = value1, value2
key3 = value1,
value2,
value3
[section2]
key = value1,
value2,
value3
Usage
type Store
type Store struct {
}
func (*Store) Defaults
func (s *Store) Defaults(input string) (err error)
Sets default settings for configuration store, ignores if already set.
func (*Store) Exists
func (s *Store) Exists(input ...string) (found bool)
Returns true if section or section and key exists.
func (*Store) File
func (s *Store) File(file string) (err error)
Reads configuration file and returns Store, file must exist even if empty.
func (*Store) Get
func (s *Store) Get(section, key string) string
Return only the first entry, if there are multiple entries the rest are skipped.
func (*Store) GetBool
func (s *Store) GetBool(section, key string) (output bool)
Get Boolean Value from config.
func (*Store) GetFloat
func (s *Store) GetFloat(section, key string) (output float64)
Get Float64 Value from config.
func (*Store) GetInt
func (s *Store) GetInt(section, key string) (output int64)
Get Int64 Value from config.
func (*Store) GetUint
func (s *Store) GetUint(section, key string) (output uint64)
Get UInt64 Value from config.
func (*Store) Keys
func (s *Store) Keys(section string) (out []string)
Returns keys of section specified.
func (*Store) MGet
func (s *Store) MGet(section, key string) []string
Returns array of all retrieved string values under section with key.
func (*Store) Parse
func (s *Store) Parse(input string) (err error)
Will parse a string, but overwrite existing config.
func (*Store) SGet
func (s *Store) SGet(section, key string) string
Returns entire line as one string, (Single Get)
func (*Store) Sanitize
func (s *Store) Sanitize(section string, keys []string) (err error)
Goes through list of sections and keys to make sure they are set.
func (*Store) Save
func (s *Store) Save(sections ...string) error
Saves section to file, recording all key = value pairs, if empty, save all sections.
func (*Store) Sections
func (s *Store) Sections() (out []string)
Returns array of all sections in config file.
func (*Store) Set
func (s *Store) Set(section, key string, value ...interface{}) (err error)
Sets key = values under [section], updates Store and saves to file.
func (*Store) TrimSave
func (s *Store) TrimSave(sections ...string) error
TrimSave is similar to Save, however it will trim unusued keys.
func (*Store) Unset
func (s *Store) Unset(input ...string)
Unsets a specified key, or specified section. If section is empty, section is removed.
Documentation
¶
Overview ¶
Package 'cfg' provides functions for reading and writing configuration files and their coresponding string values.
Ignores '#' as comments, ','s denote multiple values.
# Example config file.
[section]
key = value
key2 = value1, value2
key3 = value1,
value2,
value3
[section2]
key = value1,
value2,
value3
Index ¶
- type Store
- func (s *Store) Defaults(input string) (err error)
- func (s *Store) Exists(input ...string) (found bool)
- func (s *Store) File(file string) (err error)
- func (s *Store) Get(section, key string) string
- func (s *Store) GetBool(section, key string) (output bool)
- func (s *Store) GetFloat(section, key string) (output float64)
- func (s *Store) GetInt(section, key string) (output int64)
- func (s *Store) GetUint(section, key string) (output uint64)
- func (s *Store) Keys(section string) (out []string)
- func (s *Store) MGet(section, key string) []string
- func (s *Store) Parse(input string) (err error)
- func (s *Store) SGet(section, key string) string
- func (s *Store) Sanitize(section string, keys []string) (err error)
- func (s *Store) Save(sections ...string) error
- func (s *Store) Sections() (out []string)
- func (s *Store) Set(section, key string, value ...interface{}) (err error)
- func (s *Store) TrimSave(sections ...string) error
- func (s *Store) Unset(input ...string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
func (*Store) Get ¶
Return only the first entry, if there are multiple entries the rest are skipped.
func (*Store) Save ¶
Saves [section](s) to file, recording all key = value pairs, if empty, save all sections.
Source Files