Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

citation

package module

Go to main page

Versions in this module

v0

v0.1.0

Sep 20, 2026

Changes in this version

+ var ErrLimit = errors.New("resource limit exceeded")

+ var ErrOptions = errors.New("invalid parse options")

+ var ErrSyntax = errors.New("invalid YAML")

+ var ErrType = errors.New("invalid value type")

+ var ErrUnsupported = errors.New("unsupported YAML")

+ type Actor struct

+ func (a Actor) FamilyNames() string

+ func (a Actor) Get(name string) Value

+ func (a Actor) GivenNames() string

+ func (a Actor) IsEntity() bool

+ func (a Actor) Name() string

+ type Diagnostic struct

+ Code string

+ Message string

+ Path string

+ type Document struct

+ func Parse(data []byte) (*Document, error)

+ func ParseWithOptions(data []byte, opts ParseOptions) (*Document, error)

+ func Read(r io.Reader, opts ParseOptions) (*Document, error)

+ func ReadFile(path string, opts ParseOptions) (*Document, error)

+ func (d *Document) Authors() []Actor

+ func (d *Document) CFFVersion() string

+ func (d *Document) Contact() []Actor

+ func (d *Document) Fields() []Field

+ func (d *Document) Get(name string) Value

+ func (d *Document) PreferredCitation() (Reference, bool)

+ func (d *Document) References() []Reference

+ func (d *Document) Title() string

+ func (d *Document) Validate() []Diagnostic

+ func (d *Document) Version() Value

+ type Error struct

+ Cause error

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type Field struct

+ Name string

+ Position Position

+ Value Value

+ type Kind uint8

+ const Boolean

+ const Mapping

+ const Missing

+ const Null

+ const Number

+ const Sequence

+ const String

+ type ParseOptions struct

+ MaxBytes int64

+ MaxDepth int

+ MaxDiagnostics int

+ MaxNodes int

+ MaxNumberBytes int

+ MaxScalarBytes int

+ type Position struct

+ Column int

+ Line int

+ type Reference struct

+ func (r Reference) Authors() []Actor

+ func (r Reference) Get(name string) Value

+ func (r Reference) Title() string

+ func (r Reference) Type() string

+ type Value struct

+ func (v Value) Fields() []Field

+ func (v Value) Get(name string) Value

+ func (v Value) Items() []Value

+ func (v Value) Kind() Kind

+ func (v Value) Position() Position

+ func (v Value) Text() string