watcher

Documentation

Index

• type File
  • func (f File) Watch(ctx context.Context, reload func() error) error
• type Signal
  • func (s Signal) Watch(ctx context.Context, reload func() error) error

Types

type File

type File struct {
	Path string
}

File is a watcher implementation to watch the change for a single file. The code of this file is largely borrowed from koanf (https://github.com/knadh/koanf/blob/master/providers/file/file.go) The original implementation doesn't support context, so we have to fork and make changes downstream. License: https://github.com/knadh/koanf/blob/master/LICENSE

func (File) Watch

func (f File) Watch(ctx context.Context, reload func() error) error

Watch watches the change to the file. If the file is edited or created, the reload function will be called. note the reload function should not just load the changes made within this file, but rather it should reload the whole config stack. For example, if the flag or env takes precedence over the config file, they should remain to be so after the file changes.

type Signal

type Signal struct{}

func (Signal) Watch

func (s Signal) Watch(ctx context.Context, reload func() error) error