quick

Documentation

Index

• func FormatJSONSyntaxError(data io.Reader, offset int64) (highlight string)
• func GetVersion(filename string) (version string, err error)
• func Save(filename string, data interface{}) (err error)
• type Config
  • func Load(filename string, data interface{}) (qc Config, err error)
  • func New(data interface{}) (Config, error)
• type ConfigEncoding

Functions

func FormatJSONSyntaxError

func FormatJSONSyntaxError(data io.Reader, offset int64) (highlight string)

FormatJSONSyntaxError generates a pretty printed json syntax error since golang doesn't provide an easy way to report the location of the error

func GetVersion

func GetVersion(filename string) (version string, err error)

GetVersion - extracts the version information.

func Save

func Save(filename string, data interface{}) (err error)

Save - saves given configuration data into given file as JSON.

Types

type Config

type Config interface {
	String() string
	Version() string
	Save(string) error
	Load(string) error
	Data() interface{}
	Diff(Config) ([]structs.Field, error)
	DeepDiff(Config) ([]structs.Field, error)
}

Config - generic config interface functions

func Load

func Load(filename string, data interface{}) (qc Config, err error)

Load - loads json config from filename for the a given struct data

func New

func New(data interface{}) (Config, error)

New - instantiate a new config

type ConfigEncoding

type ConfigEncoding interface {
	Unmarshal([]byte, interface{}) error
	Marshal(interface{}) ([]byte, error)
}

ConfigEncoding is a generic interface which marshal/unmarshal configuration.