config

README

Docs: link

Documentation

Index

• Constants
• func ExpandVal(s string, mapping func(string) string) string
• type Plugin
  • func (p *Plugin) Experimental() bool
  • func (p *Plugin) Get(name string) any
  • func (p *Plugin) GracefulTimeout() time.Duration
  • func (p *Plugin) Has(name string) bool
  • func (p *Plugin) Init() error
  • func (p *Plugin) Name() string
  • func (p *Plugin) Overwrite(values map[string]any) error
  • func (p *Plugin) RRVersion() string
  • func (p *Plugin) Unmarshal(out any) error
  • func (p *Plugin) UnmarshalKey(name string, out any) error

Constants

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 Plugin

type Plugin struct {
	Path string
	// Deprecated: Prefix is deprecated and will be removed in the next major version.
	Prefix    string
	Type      string
	ReadInCfg []byte
	// user defined Flags in the form of <option>.<key> = <value>
	// which overwrites initial a config key
	Flags []string
	// ExperimentalFeatures enables experimental features
	ExperimentalFeatures bool
	// Timeout ...
	Timeout time.Duration
	// RRVersion passed from the Endure.
	Version string
	// contains filtered or unexported fields
}

func (*Plugin) Experimental

func (p *Plugin) Experimental() bool

Experimental returns true if experimental features are enabled

func (*Plugin) Get

func (p *Plugin) Get(name string) any

Get raw config in the form of a config section.

func (*Plugin) GracefulTimeout

func (p *Plugin) GracefulTimeout() time.Duration

func (*Plugin) Has

func (p *Plugin) Has(name string) bool

Has checks if a config section exists.

func (*Plugin) Init

func (p *Plugin) Init() error

Init config provider.

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns user-friendly plugin name

func (*Plugin) Overwrite

func (p *Plugin) Overwrite(values map[string]any) error

Overwrite overwriting existing config with provided values

func (*Plugin) RRVersion

func (p *Plugin) RRVersion() string

RRVersion returns current RR version

func (*Plugin) Unmarshal

func (p *Plugin) Unmarshal(out any) error

func (*Plugin) UnmarshalKey

func (p *Plugin) UnmarshalKey(name string, out any) error

UnmarshalKey reads a configuration section into a configuration object.