govanityurls/vendor/gopkg.in/yaml.v2/README.md
Brandon Philips 26a09c434d
Update to use app engine runtime go112 (#34)
* app.yaml: update to go112

Make the required changes to use go112 due to the deprecation of Go 1.9.

Migration doc:
- https://cloud.google.com/appengine/docs/standard/go111/go-differences

References:
- https://github.com/GoogleCloudPlatform/govanityurls/issues/29#issuecomment-506538041
- https://github.com/etcd-io/maintainers/issues/17

* go.mod: initial commit

Migrate this project to use go.mod and update the README.

This is part of the recommended steps to runtime: go111 and beyond.
https://cloud.google.com/appengine/docs/standard/go111/go-differences

* vendor: add dependent packages

Add all dependencies for the project via vendoring for offline builds.

* travis.yml: drop go 1.6 for 1.12

Go 1.6 is too old to have a number of builtin packages for the latest
appengine package. Remove and update to match app engine version: 1.12.

* appengine.go: remove unused file

From the go111 migration doc:
"The appengine build tag is deprecated and will not be used when
building your app for deployment.  Ensure your code still functions
correctly without it being set."

https://cloud.google.com/appengine/docs/standard/go111/go-differences

* main: respect PORT environment variable

The go111 runtime should use the PORT variable to decide the listening
http port.

"PORT The port that receives HTTP requests."
https://cloud.google.com/appengine/docs/standard/go111/runtime
2020-02-06 09:36:34 -08:00

2.6 KiB

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