ucfgwrap

package module

v0.0.0-...-375b5fb Latest Latest Go to latest Published: Nov 23, 2022 License: Apache-2.0 Imports: 3 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sapcc/ucfgwrap

Links

Open Source Insights

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 (c *Config) Unpack(to interface{}) error
- func (c *Config) Wrap(config *ucfg.Config) Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

wrap.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL