Package: gopkg.in/yaml.v3

package yaml Import Path gopkg.in/yaml.v3 (on go.dev) Dependency Relation imports 16 packages, and imported by 3 packages

Involved Source Files apic.go decode.go emitterc.go encode.go parserc.go readerc.go resolve.go scannerc.go sorter.go writerc.go d yaml.go Package yaml implements YAML support for the Go language. Source code and other details for the project are available at GitHub: https://github.com/go-yaml/yaml yamlh.go yamlprivateh.go

Code Examples Unmarshal_embedded package main import ( "fmt" "log" "gopkg.in/yaml.v3" ) // An example showing how to unmarshal embedded // structs from YAML. type StructA struct { A string `yaml:"a"` } type StructB struct { // Embedded structs are not treated as embedded in YAML by default. To do that, // add the ",inline" annotation below StructA `yaml:",inline"` B string `yaml:"b"` } var data = ` a: a string from struct A b: a string from struct B ` func main() { var b StructB err := yaml.Unmarshal([]byte(data), &b) if err != nil { log.Fatalf("cannot unmarshal data: %v", err) } fmt.Println(b.A) fmt.Println(b.B) }

Package-Level Functions (total 4)

func Marshal(in interface{}) (out []byte, err error) Marshal serializes the value provided into a YAML document. The structure of the generated document will reflect the structure of the value itself. Maps and pointers (to struct, string, int, etc) are accepted as the in value. Struct fields are only marshalled if they are exported (have an upper case first letter), and are marshalled using the field name lowercased as the default key. Custom keys may be defined via the "yaml" name in the field tag: the content preceding the first comma is used as the key, and the following comma-separated options are used to tweak the marshalling process. Conflicting names result in a runtime error. The field tag format accepted is: `(...) yaml:"[<key>][,<flag1>[,<flag2>]]" (...)` The following flags are currently supported: omitempty Only include the field if it's not set to the zero value for the type or to empty slices or maps. Zero valued structs will be omitted if all their public fields are zero, unless they implement an IsZero method (see the IsZeroer interface type), in which case the field will be excluded if IsZero returns true. flow Marshal using a flow style (useful for structs, sequences and maps). inline Inline the field, which must be a struct or a map, causing all of its fields or keys to be processed as if they were part of the outer struct. For maps, keys must not conflict with the yaml keys of other struct fields. In addition, if the key is "-", the field is ignored. For example: type T struct { F int `yaml:"a,omitempty"` B int } yaml.Marshal(&T{B: 2}) // Returns "b: 2\n" yaml.Marshal(&T{F: 1}} // Returns "a: 1\nb: 0\n"

func NewDecoder(r io.Reader) *Decoder NewDecoder returns a new decoder that reads from r. The decoder introduces its own buffering and may read data from r beyond the YAML values requested.

func NewEncoder(w io.Writer) *Encoder NewEncoder returns a new encoder that writes to w. The Encoder should be closed after use to flush all data to w.

func Unmarshal(in []byte, out interface{}) (err error) Unmarshal decodes the first document found within the in byte slice and assigns decoded values into the out value. Maps and pointers (to a struct, string, int, etc) are accepted as out values. If an internal pointer within a struct is not initialized, the yaml package will initialize it if necessary for unmarshalling the provided data. The out parameter must not be nil. The type of the decoded values should be compatible with the respective values in out. If one or more values cannot be decoded due to a type mismatches, decoding continues partially until the end of the YAML content, and a *yaml.TypeError is returned with details for all missed values. Struct fields are only unmarshalled if they are exported (have an upper case first letter), and are unmarshalled using the field name lowercased as the default key. Custom keys may be defined via the "yaml" name in the field tag: the content preceding the first comma is used as the key, and the following comma-separated options are used to tweak the marshalling process (see Marshal). Conflicting names result in a runtime error. For example: type T struct { F int `yaml:"a,omitempty"` B int } var t T yaml.Unmarshal([]byte("a: 1\nb: 2"), &t) See the documentation of Marshal for the format of tags and a list of supported tag options.

Package-Level Constants (total 11)

const AliasNode Kind = 16

const DocumentNode Kind = 1

const DoubleQuotedStyle Style = 2

const FlowStyle Style = 32

const FoldedStyle Style = 16

const LiteralStyle Style = 8

const MappingNode Kind = 4

const ScalarNode Kind = 8

const SequenceNode Kind = 2

const SingleQuotedStyle Style = 4

const TaggedStyle Style = 1