config

Documentation

Index

• Variables
• type Config
  • func New(opts ...Option) Config
• type Decoder
• type KeyValue
• type Observer
• type Option
  • func WithDecoder(d Decoder) Option
  • func WithResolver(r Resolver) Option
  • func WithSource(s ...Source) Option
• type Reader
• type Resolver
• type Source
• type Value
• type Watcher

Variables

var (
	// ErrNotFound is key not found.
	ErrNotFound = errors.New("key not found")
	// ErrTypeAssert is type assert error.
	ErrTypeAssert = errors.New("type assert error")
)

Types

type Config

type Config interface {
	Load() error
	Scan(v any) error
	Value(key string) Value
	Watch(key string, o Observer) error
	Close() error
}

func New

func New(opts ...Option) Config

type Decoder

type Decoder func(*KeyValue, map[string]any) error

type KeyValue

type KeyValue struct {
	Key    string
	Value  []byte
	Format string
}

type Observer

type Observer func(string, Value)

type Option

type Option func(*options)

Option is config option.

func WithDecoder

func WithDecoder(d Decoder) Option

WithDecoder with config decoder. DefaultDecoder behavior: If KeyValue.Format is non-empty, then KeyValue.Value will be deserialized into map[string]interface{} and stored in the config cache(map[string]interface{}) if KeyValue.Format is empty,{KeyValue.Key : KeyValue.Value} will be stored in config cache(map[string]interface{})

func WithResolver

func WithResolver(r Resolver) Option

func WithSource

func WithSource(s ...Source) Option

type Reader

type Reader interface {
	Merge(...*KeyValue) error
	Value(string) (Value, bool)
	Source() ([]byte, error)
	Resolve() error
}

type Resolver

type Resolver func(map[string]any) error

Resolver resolve placeholder in config.

type Source

type Source interface {
	Load() ([]*KeyValue, error)
	Watch() (Watcher, error)
}

type Value

type Value interface {
	Bool() (bool, error)
	Int() (int64, error)
	Float() (float64, error)
	String() (string, error)
	Duration() (time.Duration, error)
	Slice() ([]Value, error)
	Map() (map[string]Value, error)
	Scan(interface{}) error
	Load() interface{}
	Store(interface{})
}

Value is config value interface.

type Watcher

type Watcher interface {
	Next() ([]*KeyValue, error)
	Stop() error
}