config

package module

Go to main page

Versions in this module

v1

v1.4.0

Jun 9, 2026

v1.3.0

May 21, 2026

v1.2.0

May 5, 2026

Changes in this version

type Builder

+ func (b *Builder) WithoutValidation() Builder

type Config

+ func (c *Config) Validate() []error

type MutableConfig

+ func (mc *MutableConfig) Effective(path KeyPath) (Config, error)

+ func (mc *MutableConfig) EffectiveAll() (map[string]Config, error)

+ func (mc *MutableConfig) Get(path KeyPath, dest any) (MetaInfo, error)

+ func (mc *MutableConfig) Lookup(path KeyPath) (Value, bool)

+ func (mc *MutableConfig) Slice(path KeyPath) (Config, error)

+ func (mc *MutableConfig) Snapshot() Config

+ func (mc *MutableConfig) Stat(path KeyPath) (MetaInfo, bool)

+ func (mc *MutableConfig) Validate() []error

+ func (mc *MutableConfig) Walk(ctx context.Context, path KeyPath, depth int) (<-chan Value, error)

+ type YAMLAnnotation struct

+ Key *yaml.Node

+ Val *yaml.Node

v1.1.0

Apr 29, 2026

Changes in this version

+ var ErrNilCollector = errors.New("nil collector")

+ var ErrNilSchemaReader = errors.New("nil schema reader")

v1.0.0

Mar 10, 2026

Changes in this version

+ const EnvDefaultSource

+ const EnvSource

+ const FileSource

+ const Global

+ const ModifiedSource

+ const StorageSource

+ const UnknownSource

+ var Default = &DefaultMerger

+ var ErrHierarchyMismatch = errors.New("path does not match any inheritance hierarchy")

+ var ErrKeyNotFound = errors.New("key not found")

+ var ErrNoInheritance = errors.New("no inheritance hierarchy configured")

+ var ErrPathNotFound = errors.New("path not found")

+ var ErrSchemaInvalid = errors.New("schema invalid")

+ var ErrValidationFailed = errors.New("validation failed")

+ func Levels(levels ...string) []string

+ func MergeCollector(ctx context.Context, root *tree.Node, col Collector) error

+ func MergeCollectorWithMerger(ctx context.Context, root *tree.Node, col Collector, merger Merger) error

+ type Builder struct

+ func NewBuilder() Builder

+ func (b *Builder) AddCollector(collector Collector) Builder

+ func (b *Builder) Build(ctx context.Context) (Config, []error)

+ func (b *Builder) BuildMutable(ctx context.Context) (MutableConfig, []error)

+ func (b *Builder) MustWithJSONSchema(schema io.Reader) Builder

+ func (b *Builder) WithInheritance(levels []string, opts ...InheritanceOption) Builder

+ func (b *Builder) WithJSONSchema(schema io.Reader) (Builder, error)

+ func (b *Builder) WithMerger(merger Merger) Builder

+ func (b *Builder) WithValidator(validator validator.Validator) Builder

+ type Collector interface

+ KeepOrder func() bool

+ Name func() string

+ Read func(ctx context.Context) <-chan Value

+ Revision func() RevisionType

+ Source func() SourceType

+ type CollectorError struct

+ CollectorName string

+ Err error

+ func NewCollectorError(collectorName string, err error) *CollectorError

+ func (e *CollectorError) Error() string

+ func (e *CollectorError) Unwrap() error

+ type Config struct

+ func (c *Config) Effective(path KeyPath) (Config, error)

+ func (c *Config) EffectiveAll() (map[string]Config, error)

+ func (c *Config) Get(path KeyPath, dest any) (MetaInfo, error)

+ func (c *Config) Lookup(path KeyPath) (Value, bool)

+ func (c *Config) MarshalYAML() ([]byte, error)

+ func (c *Config) Slice(path KeyPath) (Config, error)

+ func (c *Config) Stat(path KeyPath) (MetaInfo, bool)

+ func (c *Config) String() string

+ func (c *Config) Walk(ctx context.Context, path KeyPath, depth int) (<-chan Value, error)

+ type DefaultMerger struct

+ func (d *DefaultMerger) CreateContext(collector Collector) MergerContext

+ func (d *DefaultMerger) MergeValue(ctx MergerContext, root *tree.Node, keyPath keypath.KeyPath, value any) error

+ type DefaultsType map[string]any

+ type InheritMergeStrategy int

+ const MergeAppend

+ const MergeDeep

+ const MergeReplace

+ type InheritanceOption func(*inheritanceConfig)

+ func WithDefaults(defaults DefaultsType) InheritanceOption

+ func WithInheritMerge(key string, strategy InheritMergeStrategy) InheritanceOption

+ func WithNoInherit(keys ...string) InheritanceOption

+ func WithNoInheritFrom(level string, keys ...string) InheritanceOption

+ type KeyPath = keypath.KeyPath

+ func NewKeyPath(p string) KeyPath

+ func NewKeyPathFromSegments(segments []string) KeyPath

+ func NewKeyPathWithDelim(p, delim string) KeyPath

+ type Merger interface

+ CreateContext func(collector Collector) MergerContext

+ MergeValue func(ctx MergerContext, root *tree.Node, path keypath.KeyPath, value any) error

+ type MergerContext interface

+ ApplyOrdering func(root *tree.Node) error

+ Collector func() Collector

+ RecordOrdering func(parent keypath.KeyPath, child string)

+ type MetaInfo = meta.Info

+ type MultiCollector interface

+ Collectors func(ctx context.Context) ([]Collector, error)

+ type MutableConfig struct

+ func (mc *MutableConfig) Delete(_ KeyPath) bool

+ func (mc *MutableConfig) Merge(other *Config) error

+ func (mc *MutableConfig) Set(path KeyPath, value any) error

+ func (mc *MutableConfig) Update(other *Config) error

+ type RevisionType = meta.RevisionType

+ type SourceInfo = meta.SourceInfo

+ type SourceType = meta.SourceType

+ type Value = value.Value

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL