Repository files navigation

The yaml package enables Go programs to comfortably encode and decode YAMLvalues. It was developed withinCanonical aspart of thejuju project, and is based on apure Go port of the well-knownlibyamlC library to parse and generate YAML data quickly and reliably.

The yaml package supports most of YAML 1.2, but preserves some behaviorfrom 1.1 for backwards compatibility.

Specifically, as of v3 of the yaml package:

• YAML 1.1 bools (yes/no, on/off) are supported as long as they are beingdecoded into a typed bool value. Otherwise they behave as a string. Booleansin YAML 1.2 aretrue/false only.
• Octals encode and decode as0777 per YAML 1.1, rather than0o777as specified in YAML 1.2, because most parsers still use the old format.Octals in the0o777 format are supported though, so new files work.
• Does not support base-60 floats. These are gone from YAML 1.2, and wereactually never supported by this package as it's clearly a poor choice.

and offers backwardscompatibility with YAML 1.1 in some cases.1.2, including support foranchors, tags, map merging, etc. Multi-document unmarshalling is not yetimplemented, and base-60 floats from YAML 1.1 are purposefully notsupported since they're a poor design and are gone in YAML 1.2.

The import path for the package isgopkg.in/yaml.v3.

To install it, run:

go get gopkg.in/yaml.v3

If opened in a browser, the import path itself leads to the API documentation:

• https://gopkg.in/yaml.v3

The package API for yaml v3 will remain stable as described ingopkg.in.

The yaml package is licensed under the MIT and Apache License 2.0 licenses.Please see the LICENSE file for details.

package mainimport ("fmt""log""gopkg.in/yaml.v3")vardata=`a: Easy!b:  c: 2  d: [3, 4]`// Note: struct fields must be public in order for unmarshal to// correctly populate the data.typeTstruct {AstringBstruct {RenamedCint`yaml:"c"`D        []int`yaml:",flow"`        }}funcmain() {t:=T{}err:=yaml.Unmarshal([]byte(data),&t)iferr!=nil {log.Fatalf("error: %v",err)        }fmt.Printf("--- t:\n%v\n\n",t)d,err:=yaml.Marshal(&t)iferr!=nil {log.Fatalf("error: %v",err)        }fmt.Printf("--- t dump:\n%s\n\n",string(d))m:=make(map[interface{}]interface{})err=yaml.Unmarshal([]byte(data),&m)iferr!=nil {log.Fatalf("error: %v",err)        }fmt.Printf("--- m:\n%v\n\n",m)d,err=yaml.Marshal(&m)iferr!=nil {log.Fatalf("error: %v",err)        }fmt.Printf("--- m dump:\n%s\n\n",string(d))}

This example will generate the following output:

--- t:{Easy! {2 [3 4]}}--- t dump:a: Easy!b:  c: 2  d: [3, 4]--- m:map[a:Easy! b:map[c:2 d:[3 4]]]--- m dump:a: Easy!b:  c: 2  d:  - 3  - 4