file

Documentation

Overview

Package file implements a koanf.Provider that reads raw bytes from files on disk to be used with a koanf.Parser to parse into conf maps.

Index

• type File
  • func Provider(path string) *File
  • func (f *File) Read() (map[string]interface{}, error)
  • func (f *File) ReadBytes() ([]byte, error)
  • func (f *File) Watch(cb func(event interface{}, err error)) error

Types

type File

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

File implements a File provider.

func Provider

func Provider(path string) *File

Provider returns a file provider.

func (*File) Read

func (f *File) Read() (map[string]interface{}, error)

Read is not supported by the file provider.

func (*File) ReadBytes

func (f *File) ReadBytes() ([]byte, error)

ReadBytes reads the contents of a file on disk and returns the bytes.

func (*File) Watch

func (f *File) Watch(cb func(event interface{}, err error)) error

Watch watches the file and triggers a callback when it changes. It is a blocking function that internally spawns a goroutine to watch for changes.