config

Documentation

Overview

Package config 表示 logs 包的配置文件处理。

Index

• type Config
  • func ParseFile(path string, unmarshal func([]byte, interface{}) error) (*Config, error)
  • func ParseJSONFile(path string) (*Config, error)
  • func ParseJSONString(data string) (*Config, error)
  • func ParseString(data string, unmarshal func([]byte, interface{}) error) (*Config, error)
  • func ParseXMLFile(path string) (*Config, error)
  • func ParseXMLString(data string) (*Config, error)
  • func ParseYAMLFile(path string) (*Config, error)
  • func ParseYAMLString(data string) (*Config, error)
  • func (cfg *Config) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (cfg *Config) Sanitize() error
  • func (cfg *Config) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Types

type Config

type Config struct {
	Attrs map[string]string  `yaml:"attrs" json:"attrs"` // 参数列表
	Items map[string]*Config `yaml:"items" json:"items"` // 若是容器，则还有子项
	// contains filtered or unexported fields
}

Config 用于表示配置文件中的数据。

提供了对 JSON、XML 和 YAML 的支持

func ParseFile

func ParseFile(path string, unmarshal func([]byte, interface{}) error) (*Config, error)

ParseFile 从文件中初始化 Config 对象，由 unmarshal 决定解析方式

func ParseJSONFile

func ParseJSONFile(path string) (*Config, error)

ParseJSONFile 从一个 JSON 文件初始化 Config 实例。

func ParseJSONString

func ParseJSONString(data string) (*Config, error)

ParseJSONString 从一个 JSON 字符串初始化 Config 实例。

func ParseString

func ParseString(data string, unmarshal func([]byte, interface{}) error) (*Config, error)

ParseString 从字符串中初始化 Config 对象，由 unmarshal 决定解析方式

func ParseXMLFile

func ParseXMLFile(path string) (*Config, error)

ParseXMLFile 从一个 XML 文件初始化 Config 实例。

func ParseXMLString

func ParseXMLString(data string) (*Config, error)

ParseXMLString 从一个 XML 字符串初始化 Config 实例。

func ParseYAMLFile

func ParseYAMLFile(path string) (*Config, error)

ParseYAMLFile 从一个 YAML 文件初始化 Config 实例。

func ParseYAMLString

func ParseYAMLString(data string) (*Config, error)

ParseYAMLString 从一个 YAML 字符串初始化 Config 实例。

func (*Config) MarshalXML

func (cfg *Config) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML xml.Unmarshaler 接口实现

func (*Config) Sanitize

func (cfg *Config) Sanitize() error

Sanitize 检测语法错误及基本的内容错误。

同时也是实现 config.Sanitizer 接口。

func (*Config) UnmarshalXML

func (cfg *Config) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML xml.Unmarshaler 接口实现