configwise

Documentation

Index

• Constants
• func ExpandVal(s string, mapping func(string) string) string
• type Configurer
  • func NewConfigurer(version string, options ...Option) (Configurer, error)
• type Option
  • func WithConfigType(tp string) Option
  • func WithFlags(flags []string) Option
  • func WithPath(path string) Option
  • func WithPrefix(prefix string) Option
  • func WithReadInCfg(readInCfg []byte) Option
• type Plugin
  • func (p *Plugin) Configurer() Configurer
  • func (p *Plugin) Init() error
  • func (p *Plugin) Name() string
  • func (p *Plugin) Provides() []*dep.Out

Constants

const (
	OpNew          = "configurer: new ->"
	OpUnmarshalKey = "configurer: unmarshal key ->"
	OpUnmarshal    = "configurer: unmarshal ->"
	OpOverwrite    = "configurer: overwrite ->"
	OpParseFlag    = "configurer: parse flag ->"
)

const DefaultGracefulTimeout = 30 * time.Second

const PluginName string = "config"

Functions

func ExpandVal

func ExpandVal(s string, mapping func(string) string) string

ExpandVal replaces ${var} or $var in the string based on the mapping function. For example, os.ExpandEnv(s) is equivalent to os.Expand(s, os.Getenv).

Types

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out interface{}) error

	// Unmarshal the config into a Struct. Make sure that the tags
	// on the fields of the structure are properly set.
	Unmarshal(out interface{}) error

	// Overwrite used to overwrite particular values in the unmarshalled config
	Overwrite(values map[string]interface{}) error

	// Get used to get config section
	Get(name string) interface{}

	// Has checks if config section exists.
	Has(name string) bool

	GracefulTimeout() time.Duration

	SetGracefulTimeout(timeout time.Duration) Configurer

	// Version returns current version
	Version() string
}

func NewConfigurer

func NewConfigurer(version string, options ...Option) (Configurer, error)

type Option

type Option func(*configurer)

func WithConfigType

func WithConfigType(tp string) Option

func WithFlags

func WithFlags(flags []string) Option

func WithPath

func WithPath(path string) Option

func WithPrefix

func WithPrefix(prefix string) Option

func WithReadInCfg

func WithReadInCfg(readInCfg []byte) Option

type Plugin

type Plugin struct {
	Cfg Configurer
}

func (*Plugin) Configurer

func (p *Plugin) Configurer() Configurer

func (*Plugin) Init

func (p *Plugin) Init() error

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Provides

func (p *Plugin) Provides() []*dep.Out