sourcefile

package

v1.0.0 Latest Latest Go to latest Published: Mar 23, 2020 License: MIT Imports: 8 Imported by: 0

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

Package sourcefile sources configuration from file.

This section is empty.

This section is empty.

func New(path string, opts ...Option) config.SourceCreationFunc

New returns a new file source.

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

File implements config.Source to fetch values from a file.

func (f *File) Name() string

Name implements config.Source interface.

func (f *File) Unmarshal(to interface{}) error

Unmarshal tries to unmarshal file to the provided interface. It returns a trivial error if load strictness is false, or the true error otherwise.

type Option func(f *File)

Option defines the function signature to apply options.

func FailOnUnknownFields() Option

FailOnUnknownFields tells the file decoder to fail if a key exists in the file but not in the destination.

func MayNotExist() Option

MayNotExist tells the file.Unmarshal function to return an error that implements IsTrivial when file does not exists.