config

Documentation

Overview

Package config is an interface for dynamic configuration.

Index

• Variables
• func Byte() []byte
• func Close() error
• func Fields() *field.Fields
• func Get(path ...string) reader.Value
• func Load(source ...source.Source) error
• func Scan(val Config) error
• func Sync() error
• type Config
• type Configurator
  • func NewConfig(opts ...Option) Configurator
• type Option
  • func WithLoader(l loader.Loader) Option
  • func WithReader(r reader.Reader) Option
  • func WithSource(s ...source.Source) Option
• type Options
• type Watcher
  • func Watch(path ...string) (Watcher, error)

Variables

var (
	// Default Config Manager
	Default = NewConfig()
)

Functions

func Byte

func Byte() []byte

Byte return config raw data

func Close

func Close() error

Close stop the config loader/watcher

func Fields

func Fields() *field.Fields

func Get

func Get(path ...string) reader.Value

Get a value from the config

func Load

func Load(source ...source.Source) error

Load config sources

func Scan

func Scan(val Config) error

Scan config to val

func Sync

func Sync() error

Sync force a source changeset sync

Types

type Config

type Config interface {
	Path() string
}

Config is set of config fields. "." is a level splitter. For example:

father.child

It means that config data's struct same as this.

{
  "father": {
    "child": {xxx}
  }
}

type Configurator

type Configurator interface {
	// Load config sources
	Load(source ...source.Source) error
	// Force a source change set sync
	Sync() error
	// Stop the config loader/watcher
	Close() error
	// Bytes get merged config data
	Bytes() []byte
	// Scan to val
	Scan(val Config) error
	// Watch field change
	Watch(path ...string) (Watcher, error)
	// Get value through field
	Get(path ...string) reader.Value
	// Scanned fields
	Fields() *field.Fields
}

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 WithLoader

func WithLoader(l loader.Loader) Option

WithLoader sets the loader for manager config

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

type Options

type Options struct {
	Loader loader.Loader
	Reader reader.Reader
	Source []source.Source

	// for alternative data
	Context context.Context
}

type Watcher

type Watcher interface {
	Next() (reader.Value, error)
	Stop() error
}

Watcher is the config watcher

func Watch

func Watch(path ...string) (Watcher, error)

Watch a value for changes