configor

Documentation

Index

• Variables
• func Load(dst any, data ...[]byte) error
• func LoadFile(dst any, files ...string) error
• func Register(suffix string, f Unmarshal)
• type Configor
  • func (c *Configor) Load(dst any, data ...[]byte) error
  • func (c *Configor) LoadFile(dst any, files ...string) error
• type Unmarshal

Variables

var Default = &Configor{
	LoadEnv:   false,
	EnvPrefix: "",
	Unmarshal: toml.Unmarshal,
	Validator: validator.New().Struct,
}

Functions

func Load

func Load(dst any, data ...[]byte) error

Load unmarshals configurations to struct from provided data using the default Configor.

func LoadFile

func LoadFile(dst any, files ...string) error

LoadFile unmarshals configurations to struct from provided files using the default Configor.

func Register

func Register(suffix string, f Unmarshal)

Register registers a new unmarshal function for a file extension.

Types

type Configor

type Configor struct {
	LoadEnv   bool            // 是否读取环境变量
	EnvPrefix string          // 环境变量前缀
	Unmarshal Unmarshal       // 解析器
	Validator func(any) error // 校验器
}

func (*Configor) Load

func (c *Configor) Load(dst any, data ...[]byte) error

Load unmarshals configurations to struct from provided data.

func (*Configor) LoadFile

func (c *Configor) LoadFile(dst any, files ...string) error

LoadFile unmarshals configurations to struct from provided files.

type Unmarshal

type Unmarshal func([]byte, any) error