config

package module

v4.8.1 Latest Latest Go to latest Published: May 2, 2024 License: MIT Imports: 9 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/roadrunner-server/config

Links

Open Source Insights

README ¶

Docs: link

Documentation ¶

Index ¶

Constants
func ExpandVal(s string, mapping func(string) string) string
type Plugin

Constants ¶

View Source

const (
	PluginName string = "config"
)

Variables ¶

This section is empty.

Functions ¶

func ExpandVal ¶ added in v4.3.0

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
	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 ¶ added in v4.5.0

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL