yaml

package

v0.8.1 Latest Latest Go to latest Published: Apr 3, 2024 License: Apache-2.0, Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cue-lang/cue

Links

Open Source Insights

README ¶

YAML reader for CUE

This yaml parser is a heavily modified version of Canonical's go-yaml parser, which in turn is a port of the libyaml parser.

License

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

Documentation ¶

Overview ¶

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

Index ¶

func Unmarshal(filename string, in []byte) (expr ast.Expr, err error)
type Decoder
- func NewDecoder(filename string, src interface{}) (*Decoder, error)
- func (dec *Decoder) Decode() (expr ast.Expr, err error)
type TypeError
- func (e *TypeError) Error() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Unmarshal ¶

func Unmarshal(filename string, in []byte) (expr ast.Expr, err error)

Unmarshal decodes the first document found within the in byte slice and returns it as a CUE syntax AST.

Types ¶

type Decoder ¶

type Decoder struct {
	// contains filtered or unexported fields
}

A Decoder reads and decodes YAML values from an input stream.

func NewDecoder ¶

func NewDecoder(filename string, src interface{}) (*Decoder, error)

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 (*Decoder) Decode ¶

func (dec *Decoder) Decode() (expr ast.Expr, err error)

Decode reads the next YAML-encoded value from its input and returns it as CUE syntax. It returns io.EOF if there are no more value in the stream.

type TypeError ¶

type TypeError struct {
	Errors []string
}

A TypeError is returned by Unmarshal when one or more fields in the YAML document cannot be properly decoded into the requested types. When this error is returned, the value is still unmarshaled partially.

func (*TypeError) Error ¶

func (e *TypeError) Error() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL