variables

Documentation

Index

• func ConvertCtyToInterface(val cty.Value) (any, error)
• type ID
  • func (p ID) String() string
• type Override
  • func (o *Override) Equal(a *Override) bool
• type Overrides
• type PackIDKeyedVarMap
• type Variable
  • func (v *Variable) AsOverrideString(pID pack.ID) string
  • func (v *Variable) Equal(ivp *Variable) bool
  • func (v *Variable) Merge(in *Variable) hcl.Diagnostics
  • func (v *Variable) SetDefault(d cty.Value)
  • func (v *Variable) SetDescription(d string)
  • func (v *Variable) SetType(t cty.Type)

Functions

func ConvertCtyToInterface

func ConvertCtyToInterface(val cty.Value) (any, error)

Types

type ID

type ID string

func (ID) String

func (p ID) String() string

type Override

type Override struct {
	Name  ID
	Path  pack.ID
	Type  cty.Type
	Value cty.Value
	Range hcl.Range
}

func (*Override) Equal

func (o *Override) Equal(a *Override) bool

type Overrides

type Overrides map[pack.ID][]*Override

type PackIDKeyedVarMap

type PackIDKeyedVarMap map[pack.ID][]*Variable

type Variable

type Variable struct {

	// Name is the variable label. This is used to identify variables being
	// overridden and during templating.
	Name ID

	// Description is an optional field which provides additional context to
	// users identifying what the variable is used for.
	Description string

	// Default is an optional field which provides a default value to be used
	// in the absence of a user-provided value. It is only in this struct for
	// documentation purposes
	Default cty.Value

	// Type represents the concrete cty type of this variable. If the type is
	// unable to be parsed into a cty type, it is invalid.
	Type cty.Type

	// Value stores the variable value and is used when converting the cty type
	// value into a Go type value.
	Value cty.Value

	// DeclRange is the position marker of the variable within the file it was
	// read from. This is used for diagnostics.
	DeclRange hcl.Range
	// contains filtered or unexported fields
}

Variable encapsulates a single variable as defined within a block according to variableFileSchema and variableBlockSchema.

func (*Variable) AsOverrideString

func (v *Variable) AsOverrideString(pID pack.ID) string

func (*Variable) Equal

func (v *Variable) Equal(ivp *Variable) bool

func (*Variable) Merge

func (v *Variable) Merge(in *Variable) hcl.Diagnostics

func (*Variable) SetDefault

func (v *Variable) SetDefault(d cty.Value)

func (*Variable) SetDescription

func (v *Variable) SetDescription(d string)

func (*Variable) SetType

func (v *Variable) SetType(t cty.Type)