body

Documentation

Index

• func CollectAttributes(bodies ...hcl.Body) []*hcl.Attribute
• func CollectBlockTypes(bodies ...hcl.Body) []string
• func CollectExpressions(bodies ...hcl.Body) []hcl.Expression
• func EmptyBody() hcl.Body
• func MergeBodies(bodies ...hcl.Body) hcl.Body
• func New(content *hcl.BodyContent) hcl.Body
• func NewContentWithAttr(attr *hcl.Attribute) *hcl.BodyContent
• func NewContentWithAttrName(name, value string) *hcl.BodyContent
• func RenameAttribute(content *hcl.BodyContent, old, new string)
• func StringSliceEquals(left, right []string) bool
• type Attributes
• type Body
  • func (e *Body) Content(_ *hcl.BodySchema) (*hcl.BodyContent, hcl.Diagnostics)
  • func (e *Body) JustAttributes() (hcl.Attributes, hcl.Diagnostics)
  • func (e *Body) MissingItemRange() hcl.Range
  • func (e *Body) PartialContent(_ *hcl.BodySchema) (*hcl.BodyContent, hcl.Body, hcl.Diagnostics)
• type MergedBodies
  • func (mb MergedBodies) Content(schema *hcl.BodySchema) (*hcl.BodyContent, hcl.Diagnostics)
  • func (mb MergedBodies) JustAllAttributes() []hcl.Attributes
  • func (mb MergedBodies) JustAllAttributesWithName(name string) []hcl.Attributes
  • func (mb MergedBodies) JustAttributes() (hcl.Attributes, hcl.Diagnostics)
  • func (mb MergedBodies) MissingItemRange() hcl.Range
  • func (mb MergedBodies) PartialContent(schema *hcl.BodySchema) (*hcl.BodyContent, hcl.Body, hcl.Diagnostics)

Functions

func CollectAttributes

func CollectAttributes(bodies ...hcl.Body) []*hcl.Attribute

func CollectBlockTypes

func CollectBlockTypes(bodies ...hcl.Body) []string

func CollectExpressions

func CollectExpressions(bodies ...hcl.Body) []hcl.Expression

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 MergeBodies

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

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

func New

func New(content *hcl.BodyContent) hcl.Body

func NewContentWithAttr

func NewContentWithAttr(attr *hcl.Attribute) *hcl.BodyContent

func NewContentWithAttrName

func NewContentWithAttrName(name, value string) *hcl.BodyContent

func RenameAttribute

func RenameAttribute(content *hcl.BodyContent, old, new string)

func StringSliceEquals

func StringSliceEquals(left, right []string) bool

Types

type Attributes

type Attributes interface {
	JustAllAttributes() []hcl.Attributes
	JustAllAttributesWithName(string) []hcl.Attributes
}

type Body

type Body struct {
	// contains filtered or unexported fields
}

func (*Body) Content

func (e *Body) Content(_ *hcl.BodySchema) (*hcl.BodyContent, hcl.Diagnostics)

func (*Body) JustAttributes

func (e *Body) JustAttributes() (hcl.Attributes, hcl.Diagnostics)

func (*Body) MissingItemRange

func (e *Body) MissingItemRange() hcl.Range

func (*Body) PartialContent

func (e *Body) PartialContent(_ *hcl.BodySchema) (*hcl.BodyContent, hcl.Body, hcl.Diagnostics)

type MergedBodies

type MergedBodies []hcl.Body

func (MergedBodies) Content

func (mb MergedBodies) Content(schema *hcl.BodySchema) (*hcl.BodyContent, hcl.Diagnostics)

Content returns the content produced by applying the given schema to all of the merged bodies and merging the result.

Although required attributes _are_ supported, they should be used sparingly with merged bodies since in this case there is no contextual information with which to return good diagnostics. Applications working with merged bodies may wish to mark all attributes as optional and then check for required attributes afterwards, to produce better diagnostics.

func (MergedBodies) JustAllAttributes

func (mb MergedBodies) JustAllAttributes() []hcl.Attributes

JustAllAttributes returns a list of attributes in order. Since these bodies got added as partialContent we do not have to supply a scheme or handle the underlying diagnostics.

func (MergedBodies) JustAllAttributesWithName

func (mb MergedBodies) JustAllAttributesWithName(name string) []hcl.Attributes

JustAllAttributesWithName behaviour is the same as JustAllAttributes with a filtered slice.

func (MergedBodies) JustAttributes

func (mb MergedBodies) JustAttributes() (hcl.Attributes, hcl.Diagnostics)

func (MergedBodies) MissingItemRange

func (mb MergedBodies) MissingItemRange() hcl.Range

MissingItemRange returns the first non-empty range if any.

func (MergedBodies) PartialContent

func (mb MergedBodies) PartialContent(schema *hcl.BodySchema) (*hcl.BodyContent, hcl.Body, hcl.Diagnostics)