file

Documentation

Overview

Package file provides config file support for uconfig

Index

• type File
  • func New(path string, unmarshal Unmarshal) File
  • func NewReader(src io.Reader, unmarshal Unmarshal) File
• type Unmarshal

Types

type File

type File interface {
	Walk(conf interface{}) error
	Parse() error
}

File is a file loader plugin for uconfig

func New

func New(path string, unmarshal Unmarshal) File

New returns an EnvSet.

func NewReader

func NewReader(src io.Reader, unmarshal Unmarshal) File

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.

type Unmarshal

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

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