You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
gitea/vendor/gopkg.in/yaml.v2
6543 d1353e1f7c
Vendor Update (#14496)
4 years ago
..
.travis.yml Vendor Update (#14496) 4 years ago
LICENSE Use Go1.11 module (#5743) 6 years ago
LICENSE.libyaml
NOTICE Use Go1.11 module (#5743) 6 years ago
README.md Use Go1.11 module (#5743) 6 years ago
apic.go Vendor Update (#14496) 4 years ago
decode.go Migrate to go-enry new version (#10906) 5 years ago
emitterc.go Use Go1.11 module (#5743) 6 years ago
encode.go workaround broken drone build (#7362) 5 years ago
go.mod Vendor Update (#14496) 4 years ago
parserc.go Use Go1.11 module (#5743) 6 years ago
readerc.go Use Go1.11 module (#5743) 6 years ago
resolve.go Migrate to go-git/go-git v5.0.0 (#10735) 5 years ago
scannerc.go Migrate to go-enry new version (#10906) 5 years ago
sorter.go Use Go1.11 module (#5743) 6 years ago
writerc.go Use Go1.11 module (#5743) 6 years ago
yaml.go Vendor Update (#14496) 4 years ago
yamlh.go Migrate to go-enry new version (#10906) 5 years ago
yamlprivateh.go

README.md

YAML support for the Go language

Introduction

The yaml package enables Go programs to comfortably encode and decode YAML values. It was developed within Canonical as part of the juju project, and is based on a pure Go port of the well-known libyaml C library to parse and generate YAML data quickly and reliably.

Compatibility

The yaml package supports most of YAML 1.1 and 1.2, including support for anchors, tags, map merging, etc. Multi-document unmarshalling is not yet implemented, and base-60 floats from YAML 1.1 are purposefully not supported since they're a poor design and are gone in YAML 1.2.

Installation and usage

The import path for the package is gopkg.in/yaml.v2.

To install it, run:

go get gopkg.in/yaml.v2

API documentation

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

API stability

The package API for yaml v2 will remain stable as described in gopkg.in.

License

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

Example

package main

import (
        "fmt"
        "log"

        "gopkg.in/yaml.v2"
)

var data = `
a: Easy!
b:
  c: 2
  d: [3, 4]
`

// Note: struct fields must be public in order for unmarshal to
// correctly populate the data.
type T struct {
        A string
        B struct {
                RenamedC int   `yaml:"c"`
                D        []int `yaml:",flow"`
        }
}

func main() {
        t := T{}
    
        err := yaml.Unmarshal([]byte(data), &t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t:\n%v\n\n", t)
    
        d, err := yaml.Marshal(&t)
        if err != 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)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m:\n%v\n\n", m)
    
        d, err = yaml.Marshal(&m)
        if err != 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