config

Documentation

Index

• type Configurable

Types

type Configurable

type Configurable interface {
	// the title of the configuration
	Name() string
	// the description of the configuration
	Description() string

	// the configuration form
	InputForm() (forms.InputForm, error)

	// retrieves the value of a key in the form. this will search
	// all groups within the form for the given key and will return
	// the value of the first input with the given key.
	GetValue(name string) (*string, error)

	// Get a copy of this Configurable instance
	Copy() (Configurable, error)

	// Returns whether the configuration is valid
	IsValid() bool

	// reset all configuration values to their defaults
	Reset()
}