ucfgwrap

README

ucfgwrap

A small wrapper for ucfg that passes a slice of ucfg.Options to every function, so you don't have to.

Documentation

Overview

Small wrapper for ucfg that passes a slice of ucfg.Options to every unpack function.

Index

• type Config
  • func FromJSON(data []byte, opts ...ucfg.Option) (Config, error)
  • func FromJSONFile(path string, opts ...ucfg.Option) (Config, error)
  • func FromYAML(data []byte, opts ...ucfg.Option) (Config, error)
  • func FromYAMLFile(path string, opts ...ucfg.Option) (Config, error)
  • func (c *Config) Unpack(to interface{}) error
  • func (c *Config) Wrap(config *ucfg.Config) Config

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config bundles a ucfg.Config with a slice of ucfg.Options.

func FromJSON

func FromJSON(data []byte, opts ...ucfg.Option) (Config, error)

FromJSON parses the given json into a ucfgwrap.Config using the given options.

func FromJSONFile

func FromJSONFile(path string, opts ...ucfg.Option) (Config, error)

FromJSONFile parses the given file into a ucfgwrap.Config using the given options.

func FromYAML

func FromYAML(data []byte, opts ...ucfg.Option) (Config, error)

FromYAML parses the given yaml into a ucfgwrap.Config using the given options.

func FromYAMLFile

func FromYAMLFile(path string, opts ...ucfg.Option) (Config, error)

FromYAMLFile parses the given file into a ucfgwrap.Config using the given options.

func (*Config) Unpack

func (c *Config) Unpack(to interface{}) error

Unpack unpacks to the given pointer.

func (*Config) Wrap

func (c *Config) Wrap(config *ucfg.Config) Config

Wrap wraps a ucfg.Config together with the options contained in the parent ucfgwrap.Config. This handy when parsing into ucfg.Configs but passing around ucfgwrap.Configs.