vmutil

Documentation

Overview

Package vmutil exposes specific functions used in the native implementation of the VM for general purpose use.

Index

• func ParseJSON(reader io.Reader) (interface{}, error)
• func ParseYAMLDocuments(reader io.Reader) ([]interface{}, error)
• func RenderYAMLDocuments(data interface{}, writer io.Writer) (retErr error)

Functions

func ParseJSON

func ParseJSON(reader io.Reader) (interface{}, error)

ParseJSON parses the contents of the reader into a data object and returns it.

func ParseYAMLDocuments

func ParseYAMLDocuments(reader io.Reader) ([]interface{}, error)

ParseYAMLDocuments parses the contents of the reader into an array of objects, one for each non-nil document in the input.

func RenderYAMLDocuments

func RenderYAMLDocuments(data interface{}, writer io.Writer) (retErr error)

RenderYAMLDocuments renders the supplied data as a series of YAML documents if the input is an array or a single document when it is not. Nils are excluded from output. If the caller wants an array to be rendered as a single document, they need to wrap it in an array first. Note that this function is not a drop-in replacement for data that requires ghodss/yaml to be rendered correctly.