Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-faster/yaml
Fork of go-yaml/yaml for go-faster needs
https://github.com/go-faster/yaml
faster go golang parser yaml
Last synced: 2 months ago
JSON representation
Fork of go-yaml/yaml for go-faster needs
- Host: GitHub
- URL: https://github.com/go-faster/yaml
- Owner: go-faster
- License: apache-2.0
- Created: 2022-07-09T09:56:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T08:30:05.000Z (11 months ago)
- Last Synced: 2024-06-19T05:54:59.091Z (8 months ago)
- Topics: faster, go, golang, parser, yaml
- Language: Go
- Homepage:
- Size: 1.97 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Authors: AUTHORS
Awesome Lists containing this project
README
# yaml [](https://pkg.go.dev/github.com/go-faster/yaml#section-documentation) [](https://codecov.io/gh/go-faster/yaml) [](https://go-faster.org/docs/projects/status#beta)
`yaml` is a YAML parser for Go. It is a fork of [`yaml`](https://github.com/go-yaml/yaml) that adds some features
to make it more useful for `go-faster` purposes, including better error reporting and performance.
## Compatibility
The yaml package supports most of YAML 1.2, but preserves some behavior
from 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 being
decoded into a typed bool value. Otherwise they behave as a string. Booleans
in YAML 1.2 are _true/false_ only.
- Octals encode and decode as _0777_ per YAML 1.1, rather than _0o777_
as specified in YAML 1.2, because most parsers still use the old format.
Octals in the _0o777_ format are supported though, so new files work.
- Does not support base-60 floats. These are gone from YAML 1.2, and were
actually never supported by this package as it's clearly a poor choice.
and offers backwards
compatibility with YAML 1.1 in some cases.
1.2, including support for
anchors, tags, map merging, etc. Multi-document unmarshaling 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 `github.com/go-faster/yaml`.
To install it, run:
go get github.com/go-faster/yaml
## API stability
Unlike the original library, this module is not guaranteed to be stable.
## Example
```Go
package main
import (
"fmt"
"log"
"github.com/go-faster/yaml"
)
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
```