config

Documentation

Index

• Variables
• func NewAtomicValue() *atomicValue
• type Config
• type Configure
  • func NewConfig(opts ...Option) *Configure
  • func (c *Configure) Load() error
  • func (c *Configure) LoadALLValue()
  • func (c *Configure) Scan(v interface{}) error
  • func (c *Configure) ScanLocalConfig() ([]string, error)
  • func (c *Configure) Value(key string) Value
• type Option
  • func WithAllowedExtensions(extensions ...string) Option
  • func WithConfigPath(path string) Option
• type PlaceholderReplacer
• type Value

Variables

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

Functions

func NewAtomicValue

func NewAtomicValue() *atomicValue

Types

type Config

type Config interface {
	Load() error              //加载配置文件
	Value(key string) Value   //获取单个key的value
	Scan(v interface{}) error //通过结构体去获取对应的值
}

type Configure

type Configure struct {
	V *viper.Viper //viper
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(opts ...Option) *Configure

func (*Configure) Load

func (c *Configure) Load() error

func (*Configure) LoadALLValue

func (c *Configure) LoadALLValue()

func (*Configure) Scan

func (c *Configure) Scan(v interface{}) error

func (*Configure) ScanLocalConfig

func (c *Configure) ScanLocalConfig() ([]string, error)

扫描本地配置

func (*Configure) Value

func (c *Configure) Value(key string) Value

type Option

type Option func(*Configure)

func WithAllowedExtensions

func WithAllowedExtensions(extensions ...string) Option

添加支持的配置文件后缀

func WithConfigPath

func WithConfigPath(path string) Option

配置文件路径

type PlaceholderReplacer

type PlaceholderReplacer func(string) string

type Value

type Value interface {
	Bool() (bool, error)
	Int() (int64, error)
	Float() (float64, error)
	String() (string, error)
	Duration() (time.Duration, error)
}