yaml

package

v0.5.2 Latest Latest Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 8 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

Package yaml provides tools for encoding and decoding YAML.

This section is empty.

View Source

var (
	YAMLToJSON = yaml.YAMLToJSON
	JSONToYAML = yaml.JSONToYAML
	Unmarshal  = yaml.Unmarshal
	Marshal    = yaml.Marshal
)

The following functions are exported for testing purposes only.

func Convert[O, I any](obj I) (o O, err error)

Convert converts an object to another object.

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

Decoder is a YAML decoder.

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new YAML decoder.

func (d *Decoder) Decode(obj any) error

Decode decodes YAML into an object.

func (d *Decoder) DecodeToUnstructured(visitFunc func(obj *unstructured.Unstructured) error) error

DecodeToUnstructured decodes YAML into a list of unstructured objects.

func (d *Decoder) DecodeUnstructured() (*unstructured.Unstructured, error)

DecodeUnstructured decodes YAML into an unstructured object.

func (d *Decoder) UndecodedUnstructured(obj *unstructured.Unstructured)

UndecodedUnstructured put a decoded unstructured object back to the decoder.

func (d *Decoder) WithErrorHandler(handler func(error) error) *Decoder

WithErrorHandler sets the error handler for the decoder.

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

Encoder is a YAML encoder.

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new YAML printer.

func (p *Encoder) Encode(obj runtime.Object) error

Encode prints the object as YAML.