config

type Configuration struct {
	Path     string // Path of the config file relative to the source root
	File     string // File name including its extension
	Name     string // File name without its extension
	Format   string // File format
	Content  []byte // File content
	FullPath string // Full path of the config file
	// contains filtered or unexported fields
}

type Configurator interface {
	// Has reports whether a config matching pattern exists.
	Has(pattern string) bool
	// Get returns the config value under pattern, falling back to def when the config is missing.
	Get(pattern string, def ...any) value.Value
	// Set sets the config value under pattern.
	Set(pattern string, value any) error
	// Match returns a [Matcher] over the given patterns.
	Match(patterns ...string) Matcher
	// Watch registers cb to be called when one of the named configs changes; empty names means every
	// config.
	Watch(cb WatchCallbackFunc, names ...string)
	// Load loads the configurations of the named source; empty file means every file of the source.
	Load(ctx context.Context, source string, file ...string) ([]*Configuration, error)
	// Store saves content as file under the named source, merging it with the existing config unless
	// override is true.
	Store(ctx context.Context, source string, file string, content any, override ...bool) error
	// Close closes the configurator and its config sources.
	Close()
}

type Decoder func(format string, content []byte) (any, error)

type Encoder func(format string, content any) ([]byte, error)

type Matcher interface {
	// Has reports whether a config exists for any of the patterns.
	Has() bool
	// Get returns the value of the first pattern that resolves, falling back to def when none does.
	Get(def ...any) value.Value
	// Scan scans the value of the first pattern that resolves into dest.
	Scan(dest any) error
}

type Mode string

type Option func(o *options)

type Scanner func(format string, content []byte, dest any) error

type Source interface {
	// Name returns the name of the source.
	Name() string
	// Load loads the configurations of the given files, or every file of the source when file is
	// empty.
	Load(ctx context.Context, file ...string) ([]*Configuration, error)
	// Store saves content as file.
	Store(ctx context.Context, file string, content []byte) error
	// Watch starts watching the source and returns a [Watcher].
	Watch(ctx context.Context) (Watcher, error)
	// Close closes the source.
	Close() error
}

type WatchCallbackFunc func(names ...string)

type Watcher interface {
	// Next blocks until a config changes and returns the changed configurations.
	Next() ([]*Configuration, error)
	// Stop stops watching.
	Stop() error
}