yaml

package

v0.19.5 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 6 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

This section is empty.

This section is empty.

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

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

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

Serialize serializes objects into YAML documents.

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

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

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(out io.Writer) K8sEncoder

NewK8sEncoder creates a K8sEncoder instance that writes to out.

func (e K8sEncoder) Encode(v any) error

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