yaml

Documentation

Index

• func Marshal(v cue.Value) (string, error)
• func MarshalStream(v cue.Value) (string, error)
• func Unmarshal(data []byte) (ast.Expr, error)
• func UnmarshalStream(data []byte) (ast.Expr, error)
• func Validate(b []byte, v pkg.Schema) (bool, error)
• func ValidatePartial(b []byte, v pkg.Schema) (bool, error)

Functions

func Marshal

func Marshal(v cue.Value) (string, error)

Marshal returns the YAML encoding of v.

func MarshalStream

func MarshalStream(v cue.Value) (string, error)

MarshalStream returns the YAML encoding of v.

func Unmarshal

func Unmarshal(data []byte) (ast.Expr, error)

Unmarshal parses the YAML to a CUE expression.

func UnmarshalStream

func UnmarshalStream(data []byte) (ast.Expr, error)

UnmarshalStream parses the YAML to a CUE list expression on success.

func Validate

func Validate(b []byte, v pkg.Schema) (bool, error)

Validate validates YAML and confirms it is an instance of schema. If the YAML source is a stream, every object must match v.

func ValidatePartial

func ValidatePartial(b []byte, v pkg.Schema) (bool, error)

ValidatePartial validates YAML and confirms it matches the constraints specified by v using unification. This means that b must be consistent with, but does not have to be an instance of v. If the YAML source is a stream, every object must match v.