use

Documentation

Overview

Package use contains types and methods to deal with block use

Index

• Constants
• type Use
  • func Decode(block *hcl.Block) (*Use, errors.Error)
  • func (use *Use) AddArgument(name string, attr hcl.Expression)
  • func (use *Use) Arguments() map[string]hcl.Expression
  • func (use *Use) Desc() hcl.Expression
  • func (use *Use) SetDesc(desc hcl.Expression)
  • func (use *Use) SetVarRef(varRef string)
  • func (use *Use) SetWhen(when hcl.Expression)
  • func (use *Use) VarRef() string
  • func (use *Use) When() hcl.Expression

Constants

const (
	// BlockUse identifier of block use.
	BlockUse = "use"
	// ArgRef argument of block use.
	ArgRef = "ref"
	// ArgDesc argument of block use.
	ArgDesc = "_desc"
	// ArgWhen argument of block use.
	ArgWhen = "when"
)

Types

type Use

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

Use defined struct.

func Decode

func Decode(block *hcl.Block) (*Use, errors.Error)

Decode converts a hcl block into a defined type Use.

func (*Use) AddArgument

func (use *Use) AddArgument(name string, attr hcl.Expression)

AddArgument add an argument to the existing values in attribute arguments.

func (*Use) Arguments

func (use *Use) Arguments() map[string]hcl.Expression

Arguments return the list of arguments.

func (*Use) Desc

func (use *Use) Desc() hcl.Expression

Desc return the attribute desc.

func (*Use) SetDesc

func (use *Use) SetDesc(desc hcl.Expression)

SetDesc set the value for attribute desc of type Use.

func (*Use) SetVarRef

func (use *Use) SetVarRef(varRef string)

SetVarRef set the value for the type Use.

func (*Use) SetWhen

func (use *Use) SetWhen(when hcl.Expression)

SetWhen set the value for attribute when of type Use.

func (*Use) VarRef

func (use *Use) VarRef() string

VarRef return the value of the attribute.

func (*Use) When

func (use *Use) When() hcl.Expression

When return the attribute when.