gitea-tea/vendor/gopkg.in/yaml.v2
6543 0d98cbd657 Update Vendors (#337)
* update & migrate gitea sdk (Fix Delete Tag Issue)
* upgraded github.com/AlecAivazis/survey v2.2.7 => v2.2.8
* upgraded github.com/adrg/xdg v0.2.3 => v0.3.1
* upgraded github.com/araddon/dateparse
* upgraded github.com/olekukonko/tablewriter v0.0.4 => v0.0.5
* upgraded gopkg.in/yaml.v2 v2.3.0 => v2.4.0

Reviewed-on: https://gitea.com/gitea/tea/pulls/337
Reviewed-by: Norwin <noerw@noreply.gitea.io>
Reviewed-by: khmarbaise <khmarbaise@noreply.gitea.io>
Co-authored-by: 6543 <6543@obermui.de>
Co-committed-by: 6543 <6543@obermui.de>
2021-03-05 18:06:25 +08:00
..
.travis.yml Update Vendors (#337) 2021-03-05 18:06:25 +08:00
LICENSE [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
LICENSE.libyaml [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
NOTICE [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
README.md [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
apic.go Update Vendors (#337) 2021-03-05 18:06:25 +08:00
decode.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
emitterc.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
encode.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
go.mod Update Vendors (#337) 2021-03-05 18:06:25 +08:00
parserc.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
readerc.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
resolve.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
scannerc.go migrate yaml lib (#130) 2020-04-28 03:39:36 +00:00
sorter.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
writerc.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00
yaml.go Update Vendors (#337) 2021-03-05 18:06:25 +08:00
yamlh.go migrate yaml lib (#130) 2020-04-28 03:39:36 +00:00
yamlprivateh.go [Vendor] Update stretchr/testify v1.3.0 -> v1.4.0 (#83) 2020-01-04 02:49:49 +00:00

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