package yaml

import "github.com/oasdiff/yaml"

Package yaml provides a wrapper around go-yaml designed to enable a better way of handling YAML when marshaling to and from structs.

In short, this package first converts YAML to JSON using go-yaml and then uses json.Marshal and json.Unmarshal to convert to or from the struct. This means that it effectively reuses the JSON struct tags as well as the custom JSON methods MarshalJSON and UnmarshalJSON unlike go-yaml.

Index ¶

• func JSONToYAML(j []byte) ([]byte, error)
• func Marshal(o interface{}) ([]byte, error)
• func Unmarshal(y []byte, o interface{}, opts ...JSONOpt) error
• func UnmarshalWithOrigin(y []byte, o interface{}, withOrigin bool, opts ...JSONOpt) error
• func YAMLToJSON(y []byte) ([]byte, error)
• type JSONOpt
• type YAMLOpt

Functions ¶

func JSONToYAML ¶

func JSONToYAML(j []byte) ([]byte, error)

JSONToYAML converts JSON to YAML.

func Marshal ¶

func Marshal(o interface{}) ([]byte, error)

Marshal the object into JSON then converts JSON to YAML and returns the YAML.

func Unmarshal ¶

func Unmarshal(y []byte, o interface{}, opts ...JSONOpt) error

Unmarshal converts YAML to JSON then uses JSON to unmarshal into an object, optionally configuring the behavior of the JSON unmarshal.

func UnmarshalWithOrigin ¶

func UnmarshalWithOrigin(y []byte, o interface{}, withOrigin bool, opts ...JSONOpt) error

UnmarshalWithOrigin is like Unmarshal but if withOrigin is true, it will include the origin information in the output.

func YAMLToJSON ¶

func YAMLToJSON(y []byte) ([]byte, error)

YAMLToJSON converts YAML to JSON. Since JSON is a subset of YAML, passing JSON through this method should be a no-op.

Things YAML can do that are not supported by JSON:

• In YAML you can have binary and null keys in your maps. These are invalid in JSON. (int and float keys are converted to strings.)
• Binary data in YAML with the !!binary tag is not supported. If you want to use binary data with this library, encode the data as base64 as usual but do not use the !!binary tag in your YAML. This will ensure the original base64 encoded data makes it all the way through to the JSON.

Types ¶

type JSONOpt ¶

type JSONOpt func(*json.Decoder) *json.Decoder

JSONOpt is a decoding option for decoding from JSON format.

type YAMLOpt ¶

type YAMLOpt func(*yaml.Decoder) *yaml.Decoder

YAMLOpt is a decoding option for decoding from YAML format.

Source Files ¶

fields.go yaml.go