yaml

package

v0.8.0 Latest Latest Go to latest Published: Jan 20, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Package yaml provides generic YAML read and write operations.

This section is empty.

This section is empty.

func Marshal(v any) ([]byte, error)

Marshal converts a value to formatted YAML.

func Read[T any](path string) (*T, error)

Read reads a YAML file and unmarshals it into a value of type T.

func Unmarshal[T any](data []byte) (*T, error)

Unmarshal parses YAML data into a value of type T.

func Write(path string, v any) error

Write marshals a value to YAML, formats it with yamlfmt, adds a copyright header and writes it to a file.

type RefString string

RefString is a string that is a reference to another resource.

func (r RefString) MarshalYAML() (any, error)

MarshalYAML implements the yaml.Marshaler interface.

func (r *RefString) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type StringSlice []string

StringSlice is a custom slice of strings that allows for fine-grained control over YAML marshaling when used with the 'omitempty' tag.

By implementing the yaml.IsZeroer interface, it ensures that:

A nil slice is considered "zero" and is omitted from the output.
An empty but initialized slice (e.g., []string{}) is NOT considered "zero" and is explicitly marshaled as an empty YAML sequence ([]).

func (s StringSlice) IsZero() bool

IsZero implements the yaml.IsZeroer interface, which determines whether a field should be considered "empty" when the 'omitempty' struct tag is used.