cfg

type Any ¶

type Any struct {
	Value       any
	Description string
	Validate    Validator
}

type Boolean ¶

type Boolean struct {
	Value       bool
	Description string
	Default     bool
}

type ConfigurationType ¶

type ConfigurationType struct {
	Description string
	New         func() any
}

ConfigurationType registers a library's configuration. New returns a pointer to a fresh configuration struct. The decoder populates its fields from the operator's config.ub. The struct's fields must be wrapper types from this package or nested structs whose fields are wrapper types; the schema walker rejects any other field type at library load. Description appears in the schema commands.

type Field ¶ added in v0.6.0

type Field struct {
	Name        string
	Type        string
	Optional    bool
	Description string

	// Fields lists an object-typed field's own fields in declaration
	// order, so help output can show nested structure. Empty for any
	// other type.
	Fields []Field
}

Field describes one field of a configuration struct, for the factory's own help output.

func Describe(ct *ConfigurationType) []Field

type Integer ¶

type Integer struct {
	Value       int64
	Description string
	Default     int64
	Validate    Validator
}

type List ¶

type List[T Value] struct {
	Value       []T
	Description string
	Default     []T
	Element     T
	Validate    Validator
}

Element supplies the schema info (description, default, validator) applied to each item. Its own Value is ignored.

type Map ¶

type Map[T Value] struct {
	Value       map[string]T
	Description string
	Default     map[string]T
	Element     T
	Validate    Validator
}

type Null ¶

type Null struct {
	Description string
}

type Number ¶

type Number struct {
	Value       float64
	Description string
	Default     float64
	Validate    Validator
}

type Object ¶

type Object[T any] struct {
	Value       T
	Description string
	Validate    Validator
}

Object wraps a user struct in a position that requires a Value, such as the element type of a List or Map. T must be a struct whose fields are wrapper types or nested structs; the schema walker rejects any other field type at library load. An optional nested struct at the top level of a Configuration uses a plain *Struct and does not need this wrapper.

type String ¶

type String struct {
	Value       string
	Description string
	Default     string
	Validate    Validator
}

type Validator ¶

type Validator interface {
	Check(any) error
	Describe() ValidatorDesc
}

Validator runs after decode to check that a value meets a library author's constraints. Describe returns a structured form so the schema commands and editor tooling can render the constraint declaratively rather than as an opaque function.

type ValidatorDesc ¶

type ValidatorDesc struct {
	Kind   string
	Params map[string]any
}

ValidatorDesc names a validator's kind and parameters. Standard kinds include "pattern", "range", "length", "enum", "all", and "custom"; introspection tools render the known kinds to their UB modifier and fall back to the description text for "custom".

type Value ¶

type Value interface {
	// contains filtered or unexported methods
}

Value is the constraint for any type that may appear as the element of a List, Map, or Set, or as a standalone field on a Configuration. The unexported marker keeps the constraint closed to wrappers defined here.