yamltemplate

Documentation

Index

• Constants
• func NewStructMetaFromMeta(meta *yamlmeta.Meta, opts MetasOpts) (structmeta.Meta, error)
• type EvaluationCtx
  • func (e EvaluationCtx) PrepareNode(parentNode template.EvaluationNode, val template.EvaluationNode) error
  • func (e EvaluationCtx) Replace(parentNodes []template.EvaluationNode, val interface{}) error
  • func (e EvaluationCtx) SetMapItemKey(node template.EvaluationNode, val interface{}) error
  • func (e EvaluationCtx) ShouldWrapRootValue(nodeVal interface{}) bool
  • func (e EvaluationCtx) WrapRootValue(val interface{}) interface{}
• type MapItemOverride
  • func (d MapItemOverride) Apply(typedMap *yamlmeta.Map, newItem *yamlmeta.MapItem) error
• type MetaAndAnnotation
• type Metas
  • func NewMetas(node yamlmeta.Node, opts MetasOpts) (Metas, error)
  • func (m Metas) NeedsEnd() bool
• type MetasOpts
• type StarlarkFragment
  • func NewStarlarkFragment(data interface{}) *StarlarkFragment
  • func (s *StarlarkFragment) AsGoValue() interface{}
  • func (s *StarlarkFragment) AsStarlarkValue() starlark.Value
  • func (s *StarlarkFragment) Freeze()
  • func (s *StarlarkFragment) Hash() (uint32, error)
  • func (s *StarlarkFragment) String() string
  • func (s *StarlarkFragment) Truth() starlark.Bool
  • func (s *StarlarkFragment) Type() string
• type Template
  • func NewTemplate(name string, opts TemplateOpts) *Template
  • func (e *Template) Compile(docSet *yamlmeta.DocumentSet) (*template.CompiledTemplate, error)
• type TemplateOpts

Constants

const (
	AnnotationMapKeyOverride structmeta.AnnotationName = "yaml/map-key-override"
)

const (
	AnnotationTextTemplatedStrings structmeta.AnnotationName = "yaml/text-templated-strings"
)

const (
	EvaluationCtxDialectName template.EvaluationCtxDialectName = "yaml"
)

Functions

func NewStructMetaFromMeta

func NewStructMetaFromMeta(meta *yamlmeta.Meta, opts MetasOpts) (structmeta.Meta, error)

Types

type EvaluationCtx

type EvaluationCtx struct{}

func (EvaluationCtx) PrepareNode

func (e EvaluationCtx) PrepareNode(
	parentNode template.EvaluationNode, val template.EvaluationNode) error

func (EvaluationCtx) Replace

func (e EvaluationCtx) Replace(
	parentNodes []template.EvaluationNode, val interface{}) error

func (EvaluationCtx) SetMapItemKey

func (e EvaluationCtx) SetMapItemKey(node template.EvaluationNode, val interface{}) error

func (EvaluationCtx) ShouldWrapRootValue

func (e EvaluationCtx) ShouldWrapRootValue(nodeVal interface{}) bool

func (EvaluationCtx) WrapRootValue

func (e EvaluationCtx) WrapRootValue(val interface{}) interface{}

type MapItemOverride

type MapItemOverride struct{}

func (MapItemOverride) Apply

func (d MapItemOverride) Apply(
	typedMap *yamlmeta.Map, newItem *yamlmeta.MapItem) error

type MetaAndAnnotation

type MetaAndAnnotation struct {
	Meta       *yamlmeta.Meta
	Annotation *structmeta.Annotation
}

type Metas

type Metas struct {
	Block       []*yamlmeta.Meta // meant to execute some code
	Values      []*yamlmeta.Meta // meant to return interpolated value
	Annotations []MetaAndAnnotation
	// contains filtered or unexported fields
}

func NewMetas

func NewMetas(node yamlmeta.Node, opts MetasOpts) (Metas, error)

func (Metas) NeedsEnd

func (m Metas) NeedsEnd() bool

type MetasOpts

type MetasOpts struct {
	IgnoreUnknown bool
}

type StarlarkFragment

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

func NewStarlarkFragment

func NewStarlarkFragment(data interface{}) *StarlarkFragment

func (*StarlarkFragment) AsGoValue

func (s *StarlarkFragment) AsGoValue() interface{}

func (*StarlarkFragment) AsStarlarkValue

func (s *StarlarkFragment) AsStarlarkValue() starlark.Value

func (*StarlarkFragment) Freeze

func (s *StarlarkFragment) Freeze()

func (*StarlarkFragment) Hash

func (s *StarlarkFragment) Hash() (uint32, error)

func (*StarlarkFragment) String

func (s *StarlarkFragment) String() string

func (*StarlarkFragment) Truth

func (s *StarlarkFragment) Truth() starlark.Bool

func (*StarlarkFragment) Type

func (s *StarlarkFragment) Type() string

type Template

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

func NewTemplate

func NewTemplate(name string, opts TemplateOpts) *Template

func (*Template) Compile

func (e *Template) Compile(docSet *yamlmeta.DocumentSet) (*template.CompiledTemplate, error)

type TemplateOpts

type TemplateOpts struct {
	IgnoreUnknownComments bool
}