yaml

Documentation

Overview

Package yaml provides tools for encoding and decoding YAML.

Index

• Variables
• func Convert[O, I any](obj I) (o O, err error)
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(obj any) error
  • func (d *Decoder) DecodeToUnstructured(visitFunc func(obj *unstructured.Unstructured) error) error
  • func (d *Decoder) DecodeUnstructured() (*unstructured.Unstructured, error)
  • func (d *Decoder) UndecodedUnstructured(obj *unstructured.Unstructured)
  • func (d *Decoder) WithErrorHandler(handler func(error) error) *Decoder
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (p *Encoder) Encode(obj any) error

Variables

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

The following functions are exported for testing purposes only.

Functions

func Convert

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

Convert converts an object to another object.

Types

type Decoder

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

Decoder is a YAML decoder.

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new YAML decoder.

func (*Decoder) Decode

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

Decode decodes YAML into an object.

func (*Decoder) DecodeToUnstructured

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

DecodeToUnstructured decodes YAML into a list of unstructured objects.

func (*Decoder) DecodeUnstructured

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

DecodeUnstructured decodes YAML into an unstructured object.

func (*Decoder) UndecodedUnstructured

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

UndecodedUnstructured put a decoded unstructured object back to the decoder.

func (*Decoder) WithErrorHandler

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

WithErrorHandler sets the error handler for the decoder.

type Encoder

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

Encoder is a YAML encoder.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new YAML printer.

func (*Encoder) Encode

func (p *Encoder) Encode(obj any) error

Encode prints the object as YAML.