walk

Documentation

Index

• func LookupSchemaMapPath(path SchemaPath, schemaMap shim.SchemaMap) (shim.Schema, error)
• func LookupSchemaPath(path SchemaPath, schema shim.Schema) (shim.Schema, error)
• func SortSchemaPaths(paths []SchemaPath)
• func VisitSchema(schema shim.Schema, visitor SchemaVisitor)
• func VisitSchemaMap(schemaMap shim.SchemaMap, visitor SchemaVisitor)
• type ElementStep
  • func (step ElementStep) GoString() string
  • func (step ElementStep) Lookup(s shim.Schema) (shim.Schema, error)
• type GetAttrStep
  • func (step GetAttrStep) GoString() string
  • func (step GetAttrStep) Lookup(s shim.Schema) (shim.Schema, error)
• type SchemaPath
  • func DecodeSchemaPath(path string) SchemaPath
  • func FromCtyPath(path cty.Path) SchemaPath
  • func FromHCtyPath(path hcty.Path) SchemaPath
  • func NewSchemaPath() SchemaPath
  • func (p SchemaPath) Copy() SchemaPath
  • func (p SchemaPath) Element() SchemaPath
  • func (p SchemaPath) EncodeSchemaPath() (string, error)
  • func (p SchemaPath) GetAttr(name string) SchemaPath
  • func (p SchemaPath) GoString() string
  • func (p SchemaPath) MarshalJSON() ([]byte, error)
  • func (p SchemaPath) MustEncodeSchemaPath() string
  • func (p *SchemaPath) UnmarshalJSON(bytes []byte) error
  • func (p SchemaPath) WithStep(suffix SchemaPathStep) SchemaPath
• type SchemaPathStep
• type SchemaVisitor

Functions

func LookupSchemaMapPath

func LookupSchemaMapPath(path SchemaPath, schemaMap shim.SchemaMap) (shim.Schema, error)

Similar to LookupSchemaPath but starts the initial step from a SchemaMap.

func LookupSchemaPath

func LookupSchemaPath(path SchemaPath, schema shim.Schema) (shim.Schema, error)

Finds a nested Schema at a given path.

func SortSchemaPaths

func SortSchemaPaths(paths []SchemaPath)

Provide a stable ordering of SchemaPaths.

Beyond determinism, there is no specific sort order.

func VisitSchema

func VisitSchema(schema shim.Schema, visitor SchemaVisitor)

Visit all nested schemas, including the current one.

func VisitSchemaMap

func VisitSchemaMap(schemaMap shim.SchemaMap, visitor SchemaVisitor)

Visit all nested schemas in a SchemaMap, keeping track of SchemaPath location.

Types

type ElementStep

type ElementStep struct{}

Drill down into a Map, Set or List element schema.

func (ElementStep) GoString

func (step ElementStep) GoString() string

func (ElementStep) Lookup

func (step ElementStep) Lookup(s shim.Schema) (shim.Schema, error)

type GetAttrStep

type GetAttrStep struct {
	Name string
}

Drill down into an attribute by the given attribute name.

func (GetAttrStep) GoString

func (step GetAttrStep) GoString() string

func (GetAttrStep) Lookup

func (step GetAttrStep) Lookup(s shim.Schema) (shim.Schema, error)

type SchemaPath

type SchemaPath []SchemaPathStep

Represents locations in a tfshim.Schema value as a sequence of steps to locate it.

An empty SchemaPath represents the current location.

Values of this type are immutable by convention, use Copy as necessary for local mutations.

func DecodeSchemaPath

func DecodeSchemaPath(path string) SchemaPath

func FromCtyPath

func FromCtyPath(path cty.Path) SchemaPath

Converts a value path to a Schema Path (zclconf package representation).

func FromHCtyPath

func FromHCtyPath(path hcty.Path) SchemaPath

Converts a value path to a Schema Path (hashicorp/go-cty representation).

func NewSchemaPath

func NewSchemaPath() SchemaPath

Builds a new empty SchemaPath.

func (SchemaPath) Copy

func (p SchemaPath) Copy() SchemaPath

func (SchemaPath) Element

func (p SchemaPath) Element() SchemaPath

func (SchemaPath) EncodeSchemaPath

func (p SchemaPath) EncodeSchemaPath() (string, error)

func (SchemaPath) GetAttr

func (p SchemaPath) GetAttr(name string) SchemaPath

func (SchemaPath) GoString

func (p SchemaPath) GoString() string

func (SchemaPath) MarshalJSON

func (p SchemaPath) MarshalJSON() ([]byte, error)

func (SchemaPath) MustEncodeSchemaPath

func (p SchemaPath) MustEncodeSchemaPath() string

func (*SchemaPath) UnmarshalJSON

func (p *SchemaPath) UnmarshalJSON(bytes []byte) error

func (SchemaPath) WithStep

func (p SchemaPath) WithStep(suffix SchemaPathStep) SchemaPath

type SchemaPathStep

type SchemaPathStep interface {
	GoString() string
	Lookup(shim.Schema) (shim.Schema, error)
	// contains filtered or unexported methods
}

Represents elements of a SchemaPath.

This interface is closed, the only the implementations given in the current package are allowed.

type SchemaVisitor

type SchemaVisitor = func(SchemaPath, shim.Schema)