config

Documentation

Index

• func Environment() string
• func SetEnvironment(env string)
• type Completable
• type Config
  • func LoadFromBytes(rawConfigs ...[]byte) (*Config, error)
  • func LoadFromFiles(paths ...string) (*Config, error)
  • func (c *Config) Complete() error
  • func (c *Config) Default() error
  • func (c *Config) Dump(out io.Writer) error
  • func (c *Config) Validate() error
• type Defaultable
• type Validatable

Functions

func Environment

func Environment() string

func SetEnvironment

func SetEnvironment(env string)

Types

type Completable

type Completable interface {
	// Complete performs any required transformations on the configuration,
	// e.g. filling a map[string]X field from an []X field with keys.
	// It is expected to modify the configuration in place.
	// The fieldPath parameter can be used to create error messages.
	Complete(fldPath *field.Path) error
}

type Config

type Config struct {
}

func LoadFromBytes

func LoadFromBytes(rawConfigs ...[]byte) (*Config, error)

LoadFromBytes builds the config from multiple raw YAML byte slices. It merges the configs together, with later configs overriding earlier ones.

func LoadFromFiles

func LoadFromFiles(paths ...string) (*Config, error)

LoadFromFiles builds the config from multiple YAML files.

func (*Config) Complete

func (c *Config) Complete() error

Complete completes the config by calling the Complete() method on each field that implements the Completable interface.

func (*Config) Default

func (c *Config) Default() error

Default defaults the config by calling the Default() method on each field that implements the Defaultable interface.

func (*Config) Dump

func (c *Config) Dump(out io.Writer) error

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the config by calling the Validate() method on each field that implements the Validatable interface.

type Defaultable

type Defaultable interface {
	// Default sets default values for the configuration.
	// It is expected to modify the configuration in place.
	// The fieldPath parameter can be used to create error messages.
	Default(fldPath *field.Path) error
}

type Validatable

type Validatable interface {
	// Validate validates the configuration.
	// It should return an error if the configuration is invalid.
	// It is not supposed to modify the configuration in any way.
	// The fieldPath parameter can be used to create error messages.
	Validate(fldPath *field.Path) error
}