How go-yaml/yaml works
This repository is a Go YAML library: callers marshal Go values to YAML or unmarshal YAML into Go values, with streaming Decoder and Encoder APIs as well. The documented workflow is represented alongside the reader, scanner, parser, resolver, node conversion, and emitter layers. Parsing and emission internals are only partially sampled, so their likely internal links are dashed and uncited; documented API usage and excerpted calls are cited where shown.
Main entry points: decode.go Go value decoder · encode.go Go value encoder · yaml.go Marshal / Unmarshal API · scannerc.go Token scanner
Components 16
Public API
- Marshal / Unmarshal API
yaml.go - Stream APIs
yaml.go - Node model
yaml.go
Decode Pipeline
- Input reader
readerc.go - Token scanner
scannerc.go - Event parser
parserc.go - Go value decoder
decode.go - Scalar resolver
resolve.go
Encode Pipeline
- Go value encoder
encode.go - Map key sorter
sorter.go - YAML emitter
emitterc.go - Output writer
writerc.go
YAML Core
- Event constructors
apic.go - Token and event types
yamlh.go - Parsing primitives
yamlprivateh.go
Other components
- Go caller
Connections 19
- Go caller → Marshal / Unmarshal API: calls
README.md - Go caller → Stream APIs: uses
README.md - Marshal / Unmarshal API → Go value decoder: decodes values
README.md - Marshal / Unmarshal API → Go value encoder: encodes values
README.md - Stream APIs → Go value decoder: decodes values
- Stream APIs → Go value encoder: encodes values
- Go value decoder → Input reader: sets parser input
decode.go - Input reader → Token scanner: supplies characters
- Token scanner → Event parser: provides tokens
- Event parser → Go value decoder: provides events
- Go value decoder → Scalar resolver: resolves scalars
- Go value decoder → Node model: builds nodes
- Go value encoder → Node model: encodes nodes
- Go value encoder → Map key sorter: sorts map keys
- Go value encoder → YAML emitter: emits events
encode.go - YAML emitter → Output writer: writes output
- Event constructors → YAML emitter: initializes emitter
- Token and event types → Event parser: defines structures
- Parsing primitives → Token scanner: supports scanning