hclparser

Documentation

Index

• func EmptyBody() hcl.Body
• func FilterExcludeBody(body hcl.Body, schema *hcl.BodySchema) hcl.Body
• func FilterIncludeBody(body hcl.Body, schema *hcl.BodySchema) hcl.Body
• func MergeBodies(bodies []hcl.Body) hcl.Body
• func MergeFiles(files []*hcl.File) hcl.Body
• func Stdlib() map[string]function.Function
• type Opt
• type ParseMeta
  • func Parse(b hcl.Body, opt Opt, val interface{}) (*ParseMeta, hcl.Diagnostics)
• type Variable
• type WithEvalContexts
• type WithGetName

Functions

func EmptyBody

func EmptyBody() hcl.Body

EmptyBody returns a body with no content. This body can be used as a placeholder when a body is required but no body content is available.

func FilterExcludeBody

func FilterExcludeBody(body hcl.Body, schema *hcl.BodySchema) hcl.Body

func FilterIncludeBody

func FilterIncludeBody(body hcl.Body, schema *hcl.BodySchema) hcl.Body

func MergeBodies

func MergeBodies(bodies []hcl.Body) hcl.Body

MergeBodies is like MergeFiles except it deals directly with bodies, rather than with entire files.

func MergeFiles

func MergeFiles(files []*hcl.File) hcl.Body

MergeFiles combines the given files to produce a single body that contains configuration from all of the given files.

The ordering of the given files decides the order in which contained elements will be returned. If any top-level attributes are defined with the same name across multiple files, a diagnostic will be produced from the Content and PartialContent methods describing this error in a user-friendly way.

func Stdlib

func Stdlib() map[string]function.Function

Types

type Opt

type Opt struct {
	LookupVar     func(string) (string, bool)
	Vars          map[string]string
	ValidateLabel func(string) error
}

type ParseMeta

type ParseMeta struct {
	Renamed      map[string]map[string][]string
	AllVariables []*Variable
}

func Parse

func Parse(b hcl.Body, opt Opt, val interface{}) (*ParseMeta, hcl.Diagnostics)

type Variable

type Variable struct {
	Name        string
	Description string
	Value       *string
}

type WithEvalContexts

type WithEvalContexts interface {
	GetEvalContexts(base *hcl.EvalContext, block *hcl.Block, loadDeps func(hcl.Expression) hcl.Diagnostics) ([]*hcl.EvalContext, error)
}

type WithGetName

type WithGetName interface {
	GetName(ectx *hcl.EvalContext, block *hcl.Block, loadDeps func(hcl.Expression) hcl.Diagnostics) (string, error)
}