config

package

v1.0.3 Latest Latest Go to latest Published: Jun 8, 2022 License: Apache-2.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

e.coding.net/goheadline/core/go-admin-core

README ¶

测试用例：

import (
	"fmt"
	"testing"
	
	"e.coding.net/goheadline/core/go-admin-core/config"
	"e.coding.net/goheadline/core/go-admin-core/config/source/file"
)

func TestApp(t *testing.T)  {
	c, err := config.NewConfig()
	if err != nil {
		t.Error(err)
	}
	err = c.Load(file.NewSource(file.WithPath("config/settings.yml")))
	if err != nil {
		t.Error(err)
	}
	fmt.Println(c.Map())
}

Documentation ¶

Overview ¶

Package config is an interface for dynamic configuration.

Index ¶

func Bytes() []byte
func Get(path ...string) reader.Value
func Load(source ...source.Source) error
func LoadFile(path string) error
func Map() map[string]interface{}
func Scan(v interface{}) error
func Sync() error
type Config
- func NewConfig(opts ...Option) (Config, error)
type Entity
type Option
type Options
type Watcher
- func Watch(path ...string) (Watcher, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Bytes ¶

func Bytes() []byte

Bytes Return config as raw json

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 LoadFile ¶

func LoadFile(path string) error

LoadFile is short hand for creating a file source and loading it

func Map ¶

func Map() map[string]interface{}

Map Return config as a map

func Scan ¶

func Scan(v interface{}) error

Scan values to a go type

func Sync ¶

func Sync() error

Sync Force a source changeset sync

Types ¶

type Config ¶

type Config interface {
	// Values provide the reader.Values interface
	reader.Values
	// Init the config
	Init(opts ...Option) error
	// Options in the config
	Options() Options
	// Close Stop the config loader/watcher
	Close() error
	// Load config sources
	Load(source ...source.Source) error
	// Sync Force a source changeset sync
	Sync() error
	// Watch a value for changes
	Watch(path ...string) (Watcher, error)
}

Config is an interface abstraction for dynamic configuration

var (
	// DefaultConfig Default Config Manager
	DefaultConfig Config
)

func NewConfig ¶

func NewConfig(opts ...Option) (Config, error)

NewConfig returns new config

type Entity ¶

type Entity interface {
	OnChange()
}

Entity 配置实体

type Option ¶

type Option func(o *Options)

Option 调用类型

func WithEntity ¶

func WithEntity(e Entity) Option

WithEntity sets the config Entity

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

	Entity Entity
}

Options 配置的参数

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
encoder Package encoder handles source encoding formats	Package encoder handles source encoding formats
json
toml
xml
yaml
loader package loader manages loading from multiple sources	package loader manages loading from multiple sources
memory
reader Package reader parses change sets and provides config values	Package reader parses change sets and provides config values
json
secrets Package secrets is an interface for encrypting and decrypting secrets	Package secrets is an interface for encrypting and decrypting secrets
box Package box is an asymmetric implementation of config/secrets using nacl/box	Package box is an asymmetric implementation of config/secrets using nacl/box
secretbox Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification	Package secretbox is a config/secrets implementation that uses nacl/secretbox to do symmetric encryption / verification
source Package source is the interface for sources	Package source is the interface for sources
env
file Package file is a file source.	Package file is a file source.
flag
memory Package memory is a memory source	Package memory is a memory source

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL