yaml

Documentation

Index

• func Join(resources [][]byte) []byte
• func Serialize[T any](objs ...T) ([][]byte, error)
• func SplitDocuments(r io.Reader) ([][]byte, error)
• type K8sEncoder
  • func NewK8sEncoder(out io.Writer) K8sEncoder
  • func (e K8sEncoder) Encode(v any) error

Functions

func Join

func Join(resources [][]byte) []byte

Join joins YAML resources into a single YAML document. It does not validate individual resources.

func Serialize

func Serialize[T any](objs ...T) ([][]byte, error)

Serialize serializes objects into YAML documents.

func SplitDocuments

func SplitDocuments(r io.Reader) ([][]byte, error)

SplitDocuments function splits content into individual document parts represented as byte slices.

Types

type K8sEncoder

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

K8sEncoder leverages the Kubernetes YAML package (sigs.k8s.io/yaml) to provide an Encoder data structure that is friendlier to the io package.

func NewK8sEncoder

func NewK8sEncoder(out io.Writer) K8sEncoder

NewK8sEncoder creates a K8sEncoder instance that writes to out.

func (K8sEncoder) Encode

func (e K8sEncoder) Encode(v any) error

Encode marshals v into YAML and writes it to e's output stream.