config

package
v1.0.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 3, 2023 License: MIT Imports: 21 Imported by: 1

README

Config

kubernetes

go get -u github.com/go-kratos/kratos/contrib/config/kubernetes/v2

apollo

go get -u github.com/go-kratos/kratos/contrib/config/apollo/v2

etcd

go get -u github.com/go-kratos/kratos/contrib/config/etcd/v2

nacos

go get -u github.com/go-kratos/kratos/contrib/config/nacos/v2

Documentation

Index

Constants

This section is empty.

Variables

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

Functions

This section is empty.

Types

type Config 

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

Config is a config interface.

func New 

func New(opts ...Option) Config

New a config with options.

type Decoder 

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

Decoder is config decoder.

type DecoderConfigOption 

type DecoderConfigOption func(*mapstructure.DecoderConfig)

type KeyValue 

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

KeyValue is config key value.

type Observer 

type Observer func(string, Value)

Observer is config observer.

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]any and stored in the config cache(map[string]any) if KeyValue.Format is empty,{KeyValue.Key : KeyValue.Value} will be stored in config cache(map[string]any)

func WithLogger 

func WithLogger(_ log.Logger) Option

WithLogger with config logger. Deprecated: use global logger instead.

func WithResolver 

func WithResolver(r Resolver) Option

WithResolver with config resolver.

func WithSource 

func WithSource(s ...Source) Option

WithSource with config source.

type Reader 

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

Reader is config reader.

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)
}

Source is config source.

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(any) error
	Load() any
	Store(any)
}

Value is config value interface.

type Watcher 

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

Watcher watches a source for changes.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.