conf

Feb 16, 2022

Changes in this version

+ func IsSecret(spec OptionSpec) bool

+ type Annotation map[string]interface

+ func (an *Annotation) With(kvs ...KeyValue) Annotation

+ func (an Annotation) Get(key string) interface{}

+ func (an Annotation) Has(key string) bool

+ type KeyValue struct

+ Key string

+ Value interface{}

+ func SecretValue() KeyValue

Feb 15, 2022

Changes in this version

+ func ValidateValue(val string, optType OptionType) error

+ type ValidationConfig struct

+ IgnoreUnknownOptions bool

+ IgnoreUnknownSections bool

Jan 27, 2022

Changes in this version

type File

+ func ParseFromEnv(prefix string, env []string, reg SectionRegistry) (*File, error)

Dec 30, 2021

Changes in this version

type OptionSpec

+ Annotations map[string]interface{}

+ func (spec *OptionSpec) HasAnnotation(name string) bool

May 26, 2021

Changes in this version

+ func DecodeFile(file *File, target interface{}, spec SectionRegistry) error

Mar 21, 2021

Changes in this version

+ func DecodeSections(sections []Section, registry OptionRegistry, receiver interface{}) error

Jan 18, 2021

Changes in this version

type Options

+ func EncodeToOptions(name string, x interface{}) (Options, error)

Jan 18, 2021

Changes in this version

+ func WriteSectionsTo(sections Sections, w io.Writer) error

type File

+ func ConvertToFile(x interface{}, path string) (*File, error)

Jan 5, 2021

Changes in this version

+ var ErrNoOptions = errors.New("no options defined")

type FileSpec

+ func (spec FileSpec) OptionsForSection(name string) (OptionRegistry, bool)

+ type OptionRegistry interface

+ All func() []OptionSpec

+ GetOption func(optName string) (OptionSpec, bool)

+ HasOption func(optName string) bool

+ type SectionRegistry interface

+ OptionsForSection func(name string) (OptionRegistry, bool)

type SectionSpec

+ func (specs SectionSpec) All() []OptionSpec

+ func (specs SectionSpec) GetOption(optName string) (OptionSpec, bool)

Jan 5, 2021

Changes in this version

+ var DurationSliceType = option("[]duration", true)

+ var DurationType = option("duration", false)

+ var ErrInvalidDuration = errors.New("invalid duration")

Dec 14, 2020

Changes in this version

+ var ErrUnknownOptionType = errors.New("unknown option type")

+ func DecodeValues(data []string, specType OptionType, receiver interface{}) error

+ type FileSpec map[string]SectionSpec

+ func (spec FileSpec) Decode(file *File, target interface{}) error

+ func (spec FileSpec) FindSection(name string) (SectionSpec, bool)

+ func (spec FileSpec) Parse(path string, r io.Reader, target interface{}) error

+ func (spec FileSpec) ParseFile(path string, target interface{}) error

type OptionSpec

+ func (spec *OptionSpec) UnmarshalJSON(blob []byte) error

+ func (spec *OptionSpec) UnmarshalSection(sec Section, sectionSpec SectionSpec) error

type Options

+ func (opts Options) GetAs(name string, specType OptionType) interface{}

+ type SectionDecoder struct

+ func NewSectionDecoder(specs []OptionSpec) *SectionDecoder

+ func (dec *SectionDecoder) AsMap(sec Section) map[string]interface{}

+ func (dec *SectionDecoder) Get(sec Section, name string) interface{}

+ type SectionSpec []OptionSpec

+ func (specs SectionSpec) FindOption(optName string) (OptionSpec, bool)

+ func (specs SectionSpec) HasOption(optName string) bool

+ type SectionUnmarshaler interface

+ UnmarshalSection func(sec Section, spec SectionSpec) error

Jul 4, 2020

Changes in this version

type OptionType

+ func TypeFromString(str string) *OptionType

Jun 22, 2020

Changes in this version

+ const DropInExt

+ const SystemdLineMax

+ const SystemdNewline

+ var AllowAny = []OptionSpec

+ var BoolType = option("bool ", false)

+ var ErrDropInSectionNotAllowed = errors.New("drop-ins not allowed for not-unique sections")

+ var ErrDropInSectionNotExists = errors.New("section defined in drop-in does not exist")

+ var ErrInvalidBoolean = errors.New("invalid boolean value")

+ var ErrInvalidFloat = errors.New("invalid floating point number)")

+ var ErrInvalidNumber = errors.New("invalid number")

+ var ErrLineTooLong = fmt.Errorf("line too long (max %d bytes)", SystemdLineMax)

+ var ErrNoSections = errors.New("task does not contain any sections")

+ var ErrOptionAllowedOnce = errors.New("option is only allowed once")

+ var ErrOptionNotExists = errors.New("option does not exist")

+ var ErrOptionNotSet = errors.New("option not set")

+ var ErrOptionRequired = errors.New("option is required")

+ var ErrUnknownSection = errors.New("unknown section")

+ var FloatSliceType = option("[]float ", true)

+ var FloatType = option("float ", false)

+ var IntSliceType = option("[]int ", true)

+ var IntType = option("int ", false)

+ var StringSliceType = option("[]string ", true)

+ var StringType = option("string ", false)

+ func ApplyDropIns(t *File, dropins []*DropIn, specs map[string]map[string]OptionSpec) error

+ func ConvertBool(s string) (bool, error)

+ func DropInSearchPaths(unitName string, rootDir string) []string

+ func IsAllowAny(spec []OptionSpec) bool

+ func IsNotSet(err error) bool

+ func IsSymlink(file string) (bool, error)

+ func SearchDropinFiles(unitName string, searchPath []string) ([]string, error)

+ func TemplateInstanceName(path string) (string, bool)

+ func ValidateFile(file *File, specs map[string][]OptionSpec) error

+ func ValidateOption(values []string, spec OptionSpec) error

+ func ValidateOptions(options Options, specs []OptionSpec) error

+ type DropIn File

+ func LoadDropIns(unitName string, searchPath []string) ([]*DropIn, error)

+ type File struct

+ Path string

+ func Deserialize(path string, f io.Reader) (*File, error)

+ func LoadFile(path string) (*File, error)

+ func ReadDir(directory, suffix string, spec map[string][]OptionSpec) ([]*File, error)

+ func ReplaceSpecifiers(f *File, sm Specifiers) (*File, error)

+ func (f *File) Clone() *File

+ type Option struct

+ Name string

+ Value string

+ type OptionSpec struct

+ Aliases []string

+ Default string

+ Description string

+ Internal bool

+ Name string

+ Required bool

+ Type OptionType

+ type OptionType interface

+ IsSliceType func() bool

+ type Options []Option

+ func ApplyDefaults(options Options, specs []OptionSpec) Options

+ func (opts Options) GetBool(name string) (bool, error)

+ func (opts Options) GetBoolDefault(name string, def bool) bool

+ func (opts Options) GetFloat(name string) (float64, error)

+ func (opts Options) GetFloatDefault(name string, def float64) float64

+ func (opts Options) GetFloatSlice(name string) ([]float64, error)

+ func (opts Options) GetInt(name string) (int64, error)

+ func (opts Options) GetIntDefault(name string, def int64) int64

+ func (opts Options) GetIntSlice(name string) ([]int64, error)

+ func (opts Options) GetRequiredFloatSlice(name string) ([]float64, error)

+ func (opts Options) GetRequiredIntSlice(name string) ([]int64, error)

+ func (opts Options) GetRequiredStringSlice(name string) ([]string, error)

+ func (opts Options) GetString(name string) (string, error)

+ func (opts Options) GetStringSlice(name string) []string

+ type Section struct

+ Name string

+ func Prepare(sec Section, specs []OptionSpec) (Section, error)

+ type Sections []Section

+ func (ss Sections) Get(name string) *Section

+ func (ss Sections) GetAll(name string) []Section

+ func (ss Sections) Has(name string) bool

+ type Specifiers map[rune]string

+ func (sm Specifiers) Get(val rune) (string, error)

+ func (sm Specifiers) Replace(str string) (string, error)