Back to

Package hcl

Latest Go to latest

The latest major version is .

Published: May 9, 2017 | License: MPL-2.0 | Module:


Package hcl decodes HCL into usable Go structures.

hcl input can come in either pure HCL format or JSON format. It can be parsed into an AST, and then decoded into a structure, or it can be decoded directly from a string into a structure.

If you choose to parse HCL into a raw AST, the benefit is that you can write custom visitor implementations to implement custom semantic checks. By default, HCL does not perform any semantic checks.


func Decode

func Decode(out interface{}, in string) error

Decode reads the given input and decodes it into the structure given by `out`.

func DecodeObject

func DecodeObject(out interface{}, n ast.Node) error

DecodeObject is a lower-level version of Decode. It decodes a raw Object into the given output.

func Parse

func Parse(input string) (*ast.File, error)

Parse parses the given input and returns the root object.

The input format can be either HCL or JSON.

func ParseBytes

func ParseBytes(in []byte) (*ast.File, error)

ParseBytes accepts as input byte slice and returns ast tree.

Input can be either JSON or HCL

func ParseString

func ParseString(input string) (*ast.File, error)

ParseString accepts input as a string and returns ast tree.

func Unmarshal

func Unmarshal(bs []byte, v interface{}) error

Unmarshal accepts a byte slice as input and writes the data to the value pointed to by v.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier