README
¶
hconf: HCL library for configuration files
hconf extends the Hashicorp HCL library and is intended to be used as configuration file format.
Configuration file API
hconf is based around a configuration file with sections, and each section can have key/value pairs.
Given a configuration file like this:
section "autoupdate" {
release_channel = "test"
}
And a Golang structure like this:
type Config struct {
Autoupdate Autoupdate `hsection:"autoupdate"`
}
type Autoupdate struct {
ReleaseChannel hconf.String `hconf:"release_channel"`
}
This could be parsed like this:
hc := hconf.New(&hconf.Config{})
config := &Config{}
err := hc.DecodeFile(config, "path/to/config.conf")
// config.Autoupdate.ReleaseChannel now contains "test"
Future Ideas
- Adding conditional
whensupport based on predicates or local command execution to allow a more flexiable configuration file. Seepredicate.go.
License
hconf is licensed under the Mozilla Public License version 2.0. See the LICENSE file for details.
Documentation
¶
Index ¶
- type Bool
- type Config
- type HC
- func (hc *HC) Decode(out interface{}, filename string, data []byte) error
- func (hc *HC) DecodeFile(out interface{}, filename string) error
- func (hc *HC) EditAndSave(filename string, section string, key string, value interface{}) error
- func (hc *HC) Get(input interface{}, section string, key string) (interface{}, token.Pos, error)
- func (hc *HC) Set(input interface{}, section string, key string, value interface{}) error
- type Int64
- type String
- type StringSlice
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HC ¶
type HC struct {
// contains filtered or unexported fields
}
func (*HC) DecodeFile ¶
Decode HC into an object
func (*HC) EditAndSave ¶
EditAndSave open's existing file, edits section/key value, saves back as a formatted HCL. (kitchen sink method)
type Int64 ¶
type Int64 struct {
// contains filtered or unexported fields
}
func (*Int64) ValueInt64 ¶
type String ¶
type String struct {
// contains filtered or unexported fields
}
func (*String) ValueString ¶
type StringSlice ¶
type StringSlice struct {
// contains filtered or unexported fields
}
func (*StringSlice) Duplicate ¶
func (s *StringSlice) Duplicate() StringSlice
func (*StringSlice) IsSet ¶
func (s *StringSlice) IsSet() bool
func (*StringSlice) SetSource ¶
func (s *StringSlice) SetSource(p token.Pos)
func (*StringSlice) SetValue ¶
func (s *StringSlice) SetValue(v []string)
func (*StringSlice) Source ¶
func (s *StringSlice) Source() token.Pos
func (*StringSlice) Value ¶
func (s *StringSlice) Value() []string
func (*StringSlice) ValueStringSlice ¶
func (s *StringSlice) ValueStringSlice() []string
Source Files
Click to show internal directories.
Click to hide internal directories.