yamlsigs.k8s.io/yaml/goyaml.v2 Index | Files

package yaml

import "sigs.k8s.io/yaml/goyaml.v2"

Index

Variables

var (
	// Unmarshal decodes the first document found within the in byte slice and assigns decoded values into the out value.
	// Deprecated: Use go.yaml.in/yaml/v2.Unmarshal directly.
	Unmarshal = gopkg_yaml.Unmarshal

	// UnmarshalStrict is like Unmarshal except that any fields that are found in the data that do not have corresponding struct members will result in an error.
	// Deprecated: Use go.yaml.in/yaml/v2.UnmarshalStrict directly.
	UnmarshalStrict = gopkg_yaml.UnmarshalStrict

	// Marshal serializes the value provided into a YAML document.
	// Deprecated: Use go.yaml.in/yaml/v2.Marshal directly.
	Marshal = gopkg_yaml.Marshal

	// NewDecoder returns a new decoder that reads from r.
	// Deprecated: Use go.yaml.in/yaml/v2.NewDecoder directly.
	NewDecoder = gopkg_yaml.NewDecoder

	// NewEncoder returns a new encoder that writes to w.
	// Deprecated: Use go.yaml.in/yaml/v2.NewEncoder directly.
	NewEncoder = gopkg_yaml.NewEncoder

	// FutureLineWrap globally disables line wrapping when encoding long strings.
	// Deprecated: Use go.yaml.in/yaml/v2.FutureLineWrap directly.
	FutureLineWrap = gopkg_yaml.FutureLineWrap
)

Function aliases for public functions from go.yaml.in/yaml/v2

Types

type Decoder

type Decoder = gopkg_yaml.Decoder

Decoder reads and decodes YAML values from an input stream. Deprecated: Use go.yaml.in/yaml/v2.Decoder directly.

type Encoder

type Encoder = gopkg_yaml.Encoder

Encoder writes YAML values to an output stream. Deprecated: Use go.yaml.in/yaml/v2.Encoder directly.

type IsZeroer

type IsZeroer = gopkg_yaml.IsZeroer

IsZeroer is used to check whether an object is zero to determine whether it should be omitted when marshaling with the omitempty flag. One notable implementation is time.Time. Deprecated: Use go.yaml.in/yaml/v2.IsZeroer directly.

type MapItem

type MapItem = gopkg_yaml.MapItem

MapItem is an item in a MapSlice. Deprecated: Use go.yaml.in/yaml/v2.MapItem directly.

type MapSlice

type MapSlice = gopkg_yaml.MapSlice

MapSlice encodes and decodes as a YAML map. The order of keys is preserved when encoding and decoding. Deprecated: Use go.yaml.in/yaml/v2.MapSlice directly.

type Marshaler

type Marshaler = gopkg_yaml.Marshaler

Marshaler is implemented by types to customize their behavior when being marshaled into a YAML document. Deprecated: Use go.yaml.in/yaml/v2.Marshaler directly.

type TypeError

type TypeError = gopkg_yaml.TypeError

TypeError is returned by Unmarshal when one or more fields in the YAML document cannot be properly decoded. Deprecated: Use go.yaml.in/yaml/v2.TypeError directly.

type Unmarshaler

type Unmarshaler = gopkg_yaml.Unmarshaler

Unmarshaler is implemented by types to customize their behavior when being unmarshaled from a YAML document. Deprecated: Use go.yaml.in/yaml/v2.Unmarshaler directly.

Source Files

yaml_aliases.go

Version
v1.5.0
Published
Jun 25, 2025
Platform
js/wasm
Imports
1 packages
Last checked
3 hours ago

Tools for package owners.