config

Documentation

Index

• Constants
• type CfgManager
  • func New(loader Loader, filePath string, options ...Option) *CfgManager
  • func (m *CfgManager) ReadConfig(v interface{}) error
• type Loader
• type Option
  • func CreateIfNotExists(v bool) Option
  • func KeyDelim(delim string) Option
  • func OnConfigChange(f func(fsnotify.Event)) Option
  • func WatchConfigFile(v bool) Option
  • func WithDefaultConfig(k string, v interface{}) Option
  • func WithDefaultConfigs(configs map[string]interface{}) Option

Constants

const (
	WriteOrCreateMask  = fsnotify.Write | fsnotify.Create
	RenameOrRemoveMask = fsnotify.Rename | fsnotify.Remove
)

Types

type CfgManager

type CfgManager struct {
	// contains filtered or unexported fields
}

func New

func New(loader Loader, filePath string, options ...Option) *CfgManager

func (*CfgManager) ReadConfig

func (m *CfgManager) ReadConfig(v interface{}) error

type Loader

type Loader interface {
	Load(path string, v interface{}) error
	Save(path string, v interface{}) error
}

type Option

type Option func(m *CfgManager)

func CreateIfNotExists

func CreateIfNotExists(v bool) Option

func KeyDelim

func KeyDelim(delim string) Option

must set before WithDefaultConfig and WithDefaultConfigs

func OnConfigChange

func OnConfigChange(f func(fsnotify.Event)) Option

file change event

func WatchConfigFile

func WatchConfigFile(v bool) Option

watch config changes,default:true

func WithDefaultConfig

func WithDefaultConfig(k string, v interface{}) Option

override configuration in v

func WithDefaultConfigs

func WithDefaultConfigs(configs map[string]interface{}) Option

override configuration in v