version

Documentation

Index

• type Converter
• type Version
  • func (v Version) String() string

Types

type Converter

type Converter interface {
	// Clone clones the config by returning a new copy of the current one.
	Clone() (Converter, error)

	// SetDefaults assigns default values to empty config fields.
	SetDefaults() error

	// GetVersion returns the config version.
	GetVersion() Version

	// ConvertNext converts the config to the next version.
	ConvertNext() (Converter, error)

	// Decode decodes the config file from YAML and updates its values.
	Decode(io.Reader) error
}

Converter defines the interface required to migrate configurations to newer versions.

type Version

type Version uint

Version defines the type for the config version number.

func (Version) String

func (v Version) String() string