file

Documentation

Overview

Package file provides config file support for uconfig

Index

• func New(path string, unmarshal Unmarshal, config Config) plugins.Plugin
• func NewReader(src io.Reader, unmarshal Unmarshal) plugins.Plugin
• type Config
• type Files
  • func (f Files) Plugins() []plugins.Plugin
• type Unmarshal

Functions

func New

func New(path string, unmarshal Unmarshal, config Config) plugins.Plugin

New returns an EnvSet.

func NewReader

func NewReader(src io.Reader, unmarshal Unmarshal) plugins.Plugin

NewReader returns a uconfig plugin that unmarshals the content of the provided io.Reader into the config using the provided unmarshal function. The src will be closed if it is an io.Closer.

Types

type Config

type Config struct {
	// indicates if a file that does not exist should be ignored.
	Optional bool
}

Config describes the options required for a file.

type Files

type Files []struct {
	Path      string
	Unmarshal Unmarshal
	Optional  bool
}

Files represents a set of file paths and the appropriate unmarshal function for the given file.

func (Files) Plugins

func (f Files) Plugins() []plugins.Plugin

Plugins constructs a slice of Plugin from the Files list of paths and unmarshal functions.

type Unmarshal

type Unmarshal func(src []byte, v interface{}) error

Unmarshal is any function that maps the source bytes to the provided config.