CeresConfigEtcd

README

ceres-config-etcd

「仅发布」配置组件etcd资源适配

Documentation

Index

• Variables
• func NewSource(c *Config) CeresConfig.Source
• type Config
  • func DefaultConfig() *Config
  • func RawConfig(key string) *Config
  • func ScanConfig(name string) *Config
  • func (c *Config) Build() CeresConfig.Source
  • func (c *Config) WithEndpoints(addrs ...string) *Config
  • func (c *Config) WithPrefix(prefix string) *Config
  • func (c *Config) WithStripPrefix(trimPrefix string) *Config
• type Marshal
• type Unmarshal

Variables

var (
	Marshals = map[string]Marshal{
		"json": json.Marshal,
		"xml":  xml.Marshal,
		"yaml": yaml.Marshal,
		"yml":  yaml.Marshal,
		"toml": func(v interface{}) ([]byte, error) {
			b := bytes.NewBuffer(nil)
			defer b.Reset()
			err := toml.NewEncoder(b).Encode(v)
			if err != nil {
				return nil, err
			}
			return b.Bytes(), nil
		},
	}
	Unmarshals = map[string]Unmarshal{
		"json": json.Unmarshal,
		"xml":  xml.Unmarshal,
		"yaml": yaml.Unmarshal,
		"yml":  yaml.Unmarshal,
		"toml": toml.Unmarshal,
	}
)

var DefaultPrefix = "/ceres/config/"

Functions

func NewSource

func NewSource(c *Config) CeresConfig.Source

创建一个资源

Types

type Config

type Config struct {
	*clientv3.Config
	Prefix     string // etcd配置路径
	TrimPrefix string // 删除掉的头部字符串
	Encoding   string // 加解密
	Ctx        context.Context
}

func DefaultConfig

func DefaultConfig() *Config

默认的配置信息

func RawConfig

func RawConfig(key string) *Config

RawConfig 返回配置

func ScanConfig

func ScanConfig(name string) *Config

ScanConfig 返回配置

func (*Config) Build

func (c *Config) Build() CeresConfig.Source

Build 根据配置信息

func (*Config) WithEndpoints

func (c *Config) WithEndpoints(addrs ...string) *Config

Addr 连接地址

func (*Config) WithPrefix

func (c *Config) WithPrefix(prefix string) *Config

Prefix 前缀

func (*Config) WithStripPrefix

func (c *Config) WithStripPrefix(trimPrefix string) *Config

TrimPrefix 去掉前缀前缀

type Marshal

type Marshal func(v interface{}) ([]byte, error)

type Unmarshal

type Unmarshal func(data []byte, v interface{}) error