config

Documentation

Overview

Package config is an interface for dynamic configuration.

Index

• type Callback
• type Config
• type Configurator
  • func NewConfig(opts ...Option) Configurator
• type Option
  • func WithDebug(debug bool) Option
  • func WithInterval(interval time.Duration) Option
  • func WithReader(r reader.Reader) Option
  • func WithSource(s ...source.Source) Option
• type Options

Types

type Callback

type Callback func(old, new value.Value)

type Config

type Config interface {
	Path() string
	Validate() error
}

type Configurator

type Configurator interface {
	Load() error                         // Load config sources
	Scan(val interface{}) error          // Scan to val
	Value(key string) value.Value        // Value get values through key
	Watch(key string, cb Callback) error // Watch key change
	Close() error                        // Close stop the config loader/watcher
}

Configurator is an interface abstraction for dynamic configuration

func NewConfig

func NewConfig(opts ...Option) Configurator

NewConfig returns new config

type Option

type Option func(o *Options)

func WithDebug

func WithDebug(debug bool) Option

WithDebug print debug log

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval sets watch interval

func WithReader

func WithReader(r reader.Reader) Option

WithReader sets the config reader

func WithSource

func WithSource(s ...source.Source) Option

WithSource appends a source to list of sources, the latter has higher priority.

type Options

type Options struct {
	Debug    io.Writer
	Interval time.Duration
	Source   []source.Source
	Reader   reader.Reader
	Context  context.Context
}