cloudconfig

package

v0.60.0 Latest Latest Go to latest Published: Apr 22, 2024 License: MIT Imports: 15 Imported by: 0

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

Package cloudconfig provides primitives for loading configuration. Based on github.com/kelseyhightower/envconfig, with modifications.

This section is empty.

This section is empty.

This section is empty.

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

Config is a config.

func New(name string, spec interface{}, options ...Option) (*Config, error)

New creates a new Config with the provided name, specification and options.

func (c *Config) Load() error

Load values into the config.

func (c *Config) MarshalLogObject(encoder zapcore.ObjectEncoder) error

MarshalLogObject implements zapcore.ObjectMarshaler.

func (c *Config) PrintUsage(w io.Writer)

PrintUsage prints usage of the config to the provided io.Writer.

type Option func(*Config)

Option is a configuration option.

func WithAdditionalSpec(name string, spec interface{}) Option

WithAdditionalSpec includes an additional specification in the config loading.

func WithEnvPrefix(envPrefix string) Option

WithEnvPrefix sets the environment prefix to use for config loading.

func WithOptionalSecrets() Option

WithOptionalSecrets overrides all secrets to be optional.

func WithYAMLServiceSpecificationFile(filename string) Option

WithYAMLServiceSpecificationFile sets the YAML service specification file to load environment variables from.

type Setter interface {
	Set(value string) error
}

Setter is implemented by types can self-deserialize values. Any type that implements flag.Value also implements Setter.