config

Documentation

Index

• Constants
• func DumpToFile(filename string, cfg Config) error
• func FromYAML(content []byte, cfg Config) error
• func Load(file string, cfg Config) error
• func LoadWithOption(file string, cfg Config, strict bool, includeEnv bool, validate bool) error
• func PrintDeprecations(deprecations []Deprecation, cfg Config, out io.Writer)
• func ToJson(cfg Config) ([]byte, error)
• func ToYAML(cfg Config) ([]byte, error)
• type BaseConfig
  • func (c BaseConfig) PostProcess() error
  • func (c BaseConfig) Sanitize()
  • func (c BaseConfig) Validate() error
• type Config
  • func ConfigForDisplay(cfg Config) (Config, error)
• type Deprecation

Constants

const SanitizedValue = "*****"

Functions

func DumpToFile

func DumpToFile(filename string, cfg Config) error

func FromYAML

func FromYAML(content []byte, cfg Config) error

func Load

func Load(file string, cfg Config) error

func LoadWithOption

func LoadWithOption(file string, cfg Config, strict bool, includeEnv bool, validate bool) error

func PrintDeprecations

func PrintDeprecations(deprecations []Deprecation, cfg Config, out io.Writer)

func ToJson

func ToJson(cfg Config) ([]byte, error)

ToJson converts through YAML, because we only have `yaml` tags on Config. This JSON cannot be parsed by json.Unmarshal because durations are marshaled by yaml to pretty form like "1s". To change it to simple json.Marshal we need to add `json` tag everywhere.

func ToYAML

func ToYAML(cfg Config) ([]byte, error)

Types

type BaseConfig

type BaseConfig struct{}

func (BaseConfig) PostProcess

func (c BaseConfig) PostProcess() error

func (BaseConfig) Sanitize

func (c BaseConfig) Sanitize()

func (BaseConfig) Validate

func (c BaseConfig) Validate() error

type Config

type Config interface {
	Sanitize()
	Validate() error
	PostProcess() error
}

func ConfigForDisplay

func ConfigForDisplay(cfg Config) (Config, error)

type Deprecation

type Deprecation struct {
	Env             string
	EnvMsg          string
	ConfigValuePath func(cfg Config) (string, bool)
	ConfigValueMsg  string
}