conf

type Annotation map[string]interface{}

type DropIn File

type File struct {
	// Path holds the path to the unit file.
	Path string

	// Sections are all sections defined in the file.
	Sections
}

type FileSpec map[string]OptionRegistry

type KeyValue struct {
	Key   string
	Value interface{}
}

type Option struct {
	// Name is the name of the option.
	Name string

	// Value holds the raw string value of the option.
	Value string
}

type OptionRegistry interface {
	// hasOptoin returns true if the option with name is defined
	// in the option registry. optName is always lowercase.
	HasOption(optName string) bool

	// GetOption returns the definition of the option defined by optName.
	// optName is always lowercase.
	GetOption(optName string) (OptionSpec, bool)

	// All returns all options defined in the option registry (if supported).
	All() []OptionSpec
}

type OptionSpec struct {
	// Name is the name of the option.
	Name string `json:"name"`

	// Aliases is a set of aliases supported by this
	// option spec. If set, there should be a "Interal"
	// option for each alias name. Otherwise system-deploy
	// will throw an error if an alias is used in the
	// configuration. Use with care!
	Aliases []string `json:"aliases,omitempty"`

	// Description is a human readable description of
	// the option.
	Description string `json:"description,omitempty"`

	// Type defines the type of the option.
	Type OptionType `json:"type,omitempty" option:"-"`

	// Required may be set to true if deploy tasks must
	// specify this option.
	Required bool `json:"required,omitempty"`

	// Default may hold the default value for this option.
	// This value is only for help purposes and is NOT SET
	// as the default for that option.
	Default string `json:"default,omitempty"`

	// Internal may be set to true to omit the option from
	// the help page.
	Internal bool `json:"internal,omitempty"`

	// Annotations can be used to add arbitrary metadata to
	// option definitions. For example, such annotations can
	// be later used in help or documentation generators.
	// Note that it is recommended to ensure annotation values
	// are JSON or Gob serializable.
	Annotations Annotation `json:"annotation,omitempty"`
}

type OptionType interface {
	IsSliceType() bool

	fmt.Stringer
	json.Marshaler
	// contains filtered or unexported methods
}

type Options []Option

type Section struct {
	Name string

	Options
}

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

type SectionRegistry interface {
	// OptionsForSection returns the option registry that defines all options
	// allowed in the section name. It returns a boolean value to
	// indicate if a section with name was found. If false is returned
	// the section is treated as unknown and an error is returned.
	// The section name is always in lowercase.
	OptionsForSection(name string) (OptionRegistry, bool)
}

type SectionSpec []OptionSpec

type SectionUnmarshaler interface {
	UnmarshalSection(sec Section, spec OptionRegistry) error
}

type Sections []Section

type Specifiers map[rune]string

type ValidationConfig struct {
	IgnoreUnknownSections bool
	IgnoreUnknownOptions  bool
}