configyaml

package
v0.1.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package configyaml decodes YAML runtime configuration.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Decode

func Decode(data []byte) (*config.Config, error)

Decode decodes a YAML configuration and resolves it: what it says, with its defaults filled in, validated.

func DecodeSpec added in v0.1.13

func DecodeSpec(data []byte) (*config.Spec, error)

DecodeSpec decodes YAML into what it says, strictly (an unknown key fails) and canonically (see config.Spec.Canonical), without defaults or validation (see config.Resolve).

func Encode added in v0.1.11

func Encode(cfg *config.Config) ([]byte, error)

Encode returns the encoding of a configuration in effect, every value written out: what `export` shows, and the form of payloads stored before Specs (they read back as Specs that set every value; see EncodeSpec).

func EncodeSpec added in v0.1.13

func EncodeSpec(spec *config.Spec) ([]byte, error)

EncodeSpec returns the deterministic encoding of spec, what it sets only: the export encoding, and the payload of configuration store revisions.

func Load

func Load(path string) (*config.Config, error)

Load reads and decodes a YAML configuration file.

func LoadSpec added in v0.1.13

func LoadSpec(path string) (*config.Spec, *config.Config, error)

LoadSpec reads a YAML configuration file: what it says, and resolved.

Types

This section is empty.

Jump to

Keyboard shortcuts

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