config

Documentation

Overview

Package config handles config struct parsing.

Index

• type CfgType
• type ChangeNotification
  • func (n ChangeNotification) String() string
• type Config
  • func New(cfg interface{}, chNotify chan<- ChangeNotification) (*Config, error)
• type Field
  • func (f *Field) Name() string
  • func (f *Field) Set(value string, version uint64) error
  • func (f *Field) Sources() map[Source]string
  • func (f *Field) String() string
  • func (f *Field) Type() string
• type Source

Types

type CfgType

type CfgType interface {
	fmt.Stringer
	SetString(string) error
}

CfgType represents an interface which any config field type must implement.

type ChangeNotification

type ChangeNotification struct {
	Name     string
	Type     string
	Previous string
	Current  string
}

ChangeNotification definition for a configuration change.

func (ChangeNotification) String

func (n ChangeNotification) String() string

type Config

type Config struct {
	Fields []*Field
}

Config manages configuration and handles updates on the values.

func New

func New(cfg interface{}, chNotify chan<- ChangeNotification) (*Config, error)

New creates a new monitor.

type Field

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

Field definition of a config value that can change.

func (*Field) Name

func (f *Field) Name() string

Name getter.

func (*Field) Set

func (f *Field) Set(value string, version uint64) error

Set the value of the field.

func (*Field) Sources

func (f *Field) Sources() map[Source]string

Sources getter.

func (*Field) String

func (f *Field) String() string

String returns string representation of field's value.

func (*Field) Type

func (f *Field) Type() string

Type getter.

type Source

type Source string

Source definition.

const (
	// SourceSeed defines a seed value.
	SourceSeed Source = "seed"
	// SourceEnv defines a value from environment variables.
	SourceEnv Source = "env"
	// SourceConsul defines a value from consul.
	SourceConsul Source = "consul"
	// SourceRedis defines a value from redis.
	SourceRedis Source = "redis"
	// SourceFlag defines a value from CLI flag.
	SourceFlag Source = "flag"
	// SourceFile defines a value from external file.
	SourceFile Source = "file"
)