hcl

package module

Go to main page

Versions in this module

v2

v2.6.0

Feb 7, 2026

Changes in this version

type AST

+ func (a *AST) Children() Entries

type Block

+ func (b *Block) Children() Entries

type MarshalOption

+ func HydratedImplicitBlocks(v bool) MarshalOption

v2.5.0

Feb 6, 2026

v2.4.0

Feb 5, 2026

Changes in this version

type MarshalOption

+ func WithDefaultTransformer(transformer func(string) string) MarshalOption

v2.3.1

Jan 6, 2026

v2.3.0

Jun 22, 2025

Changes in this version

+ type Comment struct

+ Comments CommentList

+ EndPos lexer.Position

+ Parent Node

+ Pos lexer.Position

+ func (a *Comment) Clone() Entry

+ func (a *Comment) Detach() bool

+ func (a *Comment) EndPosition() Position

+ func (a *Comment) EntryKey() string

+ func (a *Comment) Position() Position

+ func (a *Comment) String() string

+ type CommentList []string

+ func (c *CommentList) Capture(values []string) error

+ type ParseOption func(*parseConfig)

+ func WithDetachedComments(preserve bool) ParseOption

v2.2.0

May 28, 2025

v2.1.0

May 5, 2025

v2.0.0

Mar 10, 2023

Changes in this version

+ func AddParentRefs(node Node) error

+ func Marshal(v interface{}, options ...MarshalOption) ([]byte, error)

+ func MarshalAST(ast Node) ([]byte, error)

+ func MarshalASTToWriter(ast Node, w io.Writer) error

+ func StripComments(node Node) error

+ func Unmarshal(data []byte, v interface{}, options ...MarshalOption) error

+ func UnmarshalAST(ast *AST, v interface{}, options ...MarshalOption) error

+ func UnmarshalBlock(block *Block, v interface{}, options ...MarshalOption) error

+ func Visit(node Node, visitor func(node Node, next func() error) error) error

+ type AST struct

+ Entries Entries

+ Pos lexer.Position

+ Schema bool

+ TrailingComments []string

+ func BlockSchema(name string, v interface{}, options ...MarshalOption) (*AST, error)

+ func MarshalToAST(v interface{}, options ...MarshalOption) (*AST, error)

+ func MustBlockSchema(name string, v interface{}, options ...MarshalOption) *AST

+ func MustSchema(v interface{}, options ...MarshalOption) *AST

+ func Parse(r io.Reader) (*AST, error)

+ func ParseBytes(data []byte) (*AST, error)

+ func ParseString(str string) (*AST, error)

+ func Schema(v interface{}, options ...MarshalOption) (*AST, error)

+ func (a *AST) Clone() *AST

+ func (a *AST) Detach() bool

+ func (a *AST) Position() Position

+ type Attribute struct

+ Comments []string

+ Default Value

+ Enum []Value

+ Key string

+ Optional bool

+ Parent Node

+ Pos lexer.Position

+ Value Value

+ func (a *Attribute) Clone() Entry

+ func (a *Attribute) Detach() bool

+ func (a *Attribute) EntryKey() string

+ func (a *Attribute) Position() Position

+ func (a *Attribute) String() string

+ type Block struct

+ Body Entries

+ Comments []string

+ Labels []string

+ Name string

+ Parent Node

+ Pos lexer.Position

+ Repeated bool

+ TrailingComments []string

+ func (b *Block) Clone() Entry

+ func (b *Block) Detach() bool

+ func (b *Block) EntryKey() string

+ func (b *Block) Position() Position

+ type Bool struct

+ Bool bool

+ Parent Node

+ Pos lexer.Position

+ func (b *Bool) Capture(values []string) error

+ func (b *Bool) Clone() Value

+ func (b *Bool) Detach() bool

+ func (b *Bool) Position() lexer.Position

+ func (b *Bool) String() string

+ type Call struct

+ Args []Value

+ Parent Node

+ Pos lexer.Position

+ func (f *Call) Clone() *Call

+ func (f *Call) Detach() bool

+ func (f *Call) Position() lexer.Position

+ func (f *Call) String() string

+ type Entries []Entry

+ func (e Entries) MarshalJSON() ([]byte, error)

+ type Entry interface

+ Clone func() Entry

+ Detach func() bool

+ EntryKey func() string

+ type Heredoc struct

+ Delimiter string

+ Doc string

+ Parent Node

+ Pos lexer.Position

+ func (h *Heredoc) Clone() Value

+ func (h *Heredoc) Detach() bool

+ func (h *Heredoc) GetHeredoc() string

+ func (h *Heredoc) Position() lexer.Position

+ func (h *Heredoc) String() string

+ type List struct

+ List []Value

+ Parent Node

+ Pos lexer.Position

+ func (l *List) Clone() Value

+ func (l *List) Detach() bool

+ func (l *List) Position() lexer.Position

+ func (l *List) String() string

+ type Map struct

+ Entries []*MapEntry

+ Parent Node

+ Pos lexer.Position

+ func (m *Map) Clone() Value

+ func (m *Map) Detach() bool

+ func (m *Map) Position() lexer.Position

+ func (m *Map) String() string

+ type MapEntry struct

+ Comments []string

+ Key Value

+ Parent Node

+ Pos lexer.Position

+ Value Value

+ func (e *MapEntry) Clone() *MapEntry

+ func (e *MapEntry) Detach() bool

+ func (e *MapEntry) Position() Position

+ type MarshalOption func(options *marshalState)

+ func AllowExtra(ok bool) MarshalOption

+ func BareBooleanAttributes(v bool) MarshalOption

+ func HereDocsForMultiLine(n int) MarshalOption

+ func InferHCLTags(v bool) MarshalOption

+ func WithSchemaComments(v bool) MarshalOption

+ type Node interface

+ Detach func() bool

+ Position func() Position

+ func Find(node Node, names ...string) (nodes []Node)

+ type Number struct

+ Float *big.Float

+ Parent Node

+ Pos lexer.Position

+ func (n *Number) Clone() Value

+ func (n *Number) Detach() bool

+ func (n *Number) GoString() string

+ func (n *Number) Parse(lex *lexer.PeekingLexer) error

+ func (n *Number) Position() lexer.Position

+ func (n *Number) String() string

+ type Position = lexer.Position

+ type RecursiveEntry struct

+ func (*RecursiveEntry) Clone() Entry

+ func (*RecursiveEntry) Detach() bool

+ func (*RecursiveEntry) EntryKey() string

+ func (*RecursiveEntry) Position() Position

+ type String struct

+ Parent Node

+ Pos lexer.Position

+ Str string

+ func (s *String) Clone() Value

+ func (s *String) Detach() bool

+ func (s *String) Position() lexer.Position

+ func (s *String) String() string

+ type Type struct

+ Parent Node

+ Pos lexer.Position

+ Type string

+ func (t *Type) Clone() Value

+ func (t *Type) Detach() bool

+ func (t *Type) Position() lexer.Position

+ func (t *Type) String() string

+ type Value interface

+ Clone func() Value

+ String func() string

v2.0.0-alpha.6

Jan 14, 2023

v2.0.0-alpha.5

Oct 12, 2022

v2.0.0-alpha.4

Oct 11, 2022

v2.0.0-alpha.3

Oct 11, 2022

v2.0.0-alpha.2

Oct 7, 2022

v2.0.0-alpha.1

Oct 5, 2022

Other modules containing this package

github.com/alecthomas/hcl

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL