Documentation ¶
Overview ¶
Copyright 2020 VMware, Inc. SPDX-License-Identifier: Apache-2.0
Index ¶
- Constants
- func SortFilesInLibrary(files []*FileInLibrary)
- type DataLoader
- type DataValues
- func NewDataValues(doc *yamlmeta.Document) (*DataValues, error)
- func NewDataValuesWithLib(libRefs ExtractLibRefs, doc *yamlmeta.Document, libRefStr string) (*DataValues, error)
- func NewDataValuesWithOptionalLib(doc *yamlmeta.Document, libRefStr string) (*DataValues, error)
- func NewEmptyDataValues() *DataValues
- type DataValuesPreProcessing
- type DocExtractor
- type EvalExport
- type EvalResult
- type ExtractLibRefs
- type FileInLibrary
- type Library
- func (l *Library) CreateLibrary(name string) *Library
- func (l *Library) FindAccessibleLibrary(path string) (*Library, error)
- func (l *Library) FindFile(path string) (FileInLibrary, error)
- func (l *Library) FindLibrary(path string) (*Library, error)
- func (l *Library) ListAccessibleFiles() []*FileInLibrary
- func (l *Library) Print(out io.Writer)
- func (l *Library) PrintStr() string
- type LibraryExecutionContext
- type LibraryExecutionFactory
- type LibraryLoader
- func (ll *LibraryLoader) Eval(values *DataValues, libraryValues []*DataValues, ...) (*EvalResult, error)
- func (ll *LibraryLoader) Schemas(schemaOverlays []*schema.DocumentSchemaEnvelope) (Schema, []*schema.DocumentSchemaEnvelope, error)
- func (ll *LibraryLoader) Values(valuesOverlays []*DataValues, schema Schema) (*DataValues, []*DataValues, error)
- type LibraryModule
- type OverlayPostProcessing
- type Schema
- type TemplateLoader
- func (l *TemplateLoader) EvalStarlark(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, error)
- func (l *TemplateLoader) EvalText(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, *texttemplate.NodeRoot, error)
- func (l *TemplateLoader) EvalYAML(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, *yamlmeta.DocumentSet, error)
- func (l *TemplateLoader) FindCompiledTemplate(path string) (*template.CompiledTemplate, error)
- func (l *TemplateLoader) Load(thread *starlark.Thread, module string) (starlark.StringDict, error)
- func (l *TemplateLoader) ParseYAML(file *files.File) (*yamlmeta.DocumentSet, error)
- type TemplateLoaderOpts
- type TemplateLoaderOptsOverrides
Constants ¶
View Source
const ( AnnotationDataValues structmeta.AnnotationName = "data/values" AnnotationDataValuesSchema structmeta.AnnotationName = "data/values-schema" )
View Source
const (
AnnotationLibraryRef = "library/ref"
)
Variables ¶
This section is empty.
Functions ¶
func SortFilesInLibrary ¶ added in v0.13.0
func SortFilesInLibrary(files []*FileInLibrary)
Types ¶
type DataLoader ¶ added in v0.27.0
type DataLoader struct {
// contains filtered or unexported fields
}
type DataValues ¶ added in v0.28.0
type DataValues struct { Doc *yamlmeta.Document AfterLibMod bool // contains filtered or unexported fields }
func NewDataValues ¶ added in v0.28.0
func NewDataValues(doc *yamlmeta.Document) (*DataValues, error)
func NewDataValuesWithLib ¶ added in v0.28.0
func NewDataValuesWithLib(libRefs ExtractLibRefs, doc *yamlmeta.Document, libRefStr string) (*DataValues, error)
func NewDataValuesWithOptionalLib ¶ added in v0.28.0
func NewDataValuesWithOptionalLib(doc *yamlmeta.Document, libRefStr string) (*DataValues, error)
func NewEmptyDataValues ¶ added in v0.28.0
func NewEmptyDataValues() *DataValues
func (*DataValues) Desc ¶ added in v0.28.0
func (dvd *DataValues) Desc() string
func (*DataValues) IntendedForAnotherLibrary ¶ added in v0.34.0
func (dvd *DataValues) IntendedForAnotherLibrary() bool
func (*DataValues) IsUsed ¶ added in v0.28.0
func (dvd *DataValues) IsUsed() bool
func (*DataValues) UsedInLibrary ¶ added in v0.28.0
func (dvd *DataValues) UsedInLibrary(expectedRefPiece ref.LibraryRef) *DataValues
type DataValuesPreProcessing ¶ added in v0.15.0
type DataValuesPreProcessing struct { IgnoreUnknownComments bool // TODO remove? // contains filtered or unexported fields }
func (DataValuesPreProcessing) Apply ¶ added in v0.15.0
func (o DataValuesPreProcessing) Apply() (*DataValues, []*DataValues, error)
type DocExtractor ¶ added in v0.31.0
type DocExtractor struct {
DocSet *yamlmeta.DocumentSet
}
func (DocExtractor) Extract ¶ added in v0.31.0
func (v DocExtractor) Extract(annName structmeta.AnnotationName) ([]*yamlmeta.Document, []*yamlmeta.Document, error)
type EvalExport ¶ added in v0.23.0
type EvalExport struct { Path string Symbols starlark.StringDict }
type EvalResult ¶ added in v0.15.0
type EvalResult struct { Files []files.OutputFile DocSet *yamlmeta.DocumentSet Exports []EvalExport }
type ExtractLibRefs ¶ added in v0.34.0
type ExtractLibRefs interface { FromStr(string) ([]ref.LibraryRef, error) FromAnnotation(template.NodeAnnotations) ([]ref.LibraryRef, error) }
type FileInLibrary ¶ added in v0.5.0
type FileInLibrary struct { File *files.File Library *Library // contains filtered or unexported fields }
func (*FileInLibrary) RelativePath ¶ added in v0.15.0
func (fileInLib *FileInLibrary) RelativePath() string
type Library ¶
type Library struct {
// contains filtered or unexported fields
}
func NewRootLibrary ¶
func (*Library) CreateLibrary ¶
func (*Library) FindAccessibleLibrary ¶
func (*Library) ListAccessibleFiles ¶
func (l *Library) ListAccessibleFiles() []*FileInLibrary
type LibraryExecutionContext ¶ added in v0.24.0
type LibraryExecutionFactory ¶ added in v0.23.0
type LibraryExecutionFactory struct {
// contains filtered or unexported fields
}
func NewLibraryExecutionFactory ¶ added in v0.23.0
func NewLibraryExecutionFactory(ui ui.UI, templateLoaderOpts TemplateLoaderOpts) *LibraryExecutionFactory
func (*LibraryExecutionFactory) New ¶ added in v0.23.0
func (f *LibraryExecutionFactory) New(ctx LibraryExecutionContext) *LibraryLoader
func (*LibraryExecutionFactory) WithTemplateLoaderOptsOverrides ¶ added in v0.31.0
func (f *LibraryExecutionFactory) WithTemplateLoaderOptsOverrides(overrides TemplateLoaderOptsOverrides) *LibraryExecutionFactory
type LibraryLoader ¶ added in v0.15.0
type LibraryLoader struct {
// contains filtered or unexported fields
}
func NewLibraryLoader ¶ added in v0.15.0
func NewLibraryLoader(libraryCtx LibraryExecutionContext, ui ui.UI, templateLoaderOpts TemplateLoaderOpts, libraryExecFactory *LibraryExecutionFactory) *LibraryLoader
func (*LibraryLoader) Eval ¶ added in v0.15.0
func (ll *LibraryLoader) Eval(values *DataValues, libraryValues []*DataValues, librarySchemas []*schema.DocumentSchemaEnvelope) (*EvalResult, error)
func (*LibraryLoader) Schemas ¶ added in v0.31.0
func (ll *LibraryLoader) Schemas(schemaOverlays []*schema.DocumentSchemaEnvelope) (Schema, []*schema.DocumentSchemaEnvelope, error)
func (*LibraryLoader) Values ¶ added in v0.15.0
func (ll *LibraryLoader) Values(valuesOverlays []*DataValues, schema Schema) (*DataValues, []*DataValues, error)
type LibraryModule ¶ added in v0.23.0
type LibraryModule struct {
// contains filtered or unexported fields
}
func NewLibraryModule ¶ added in v0.23.0
func NewLibraryModule(libraryCtx LibraryExecutionContext, libraryExecutionFactory *LibraryExecutionFactory, libraryValues []*DataValues, librarySchemas []*schema.DocumentSchemaEnvelope) LibraryModule
func (LibraryModule) AsModule ¶ added in v0.23.0
func (b LibraryModule) AsModule() starlark.StringDict
type OverlayPostProcessing ¶ added in v0.15.0
type OverlayPostProcessing struct {
// contains filtered or unexported fields
}
func (OverlayPostProcessing) Apply ¶ added in v0.15.0
func (o OverlayPostProcessing) Apply() (map[*FileInLibrary]*yamlmeta.DocumentSet, error)
type TemplateLoader ¶
type TemplateLoader struct {
// contains filtered or unexported fields
}
func NewTemplateLoader ¶
func NewTemplateLoader(values *DataValues, libraryValuess []*DataValues, librarySchemas []*schema.DocumentSchemaEnvelope, opts TemplateLoaderOpts, libraryExecFactory *LibraryExecutionFactory, ui ui.UI) *TemplateLoader
func (*TemplateLoader) EvalStarlark ¶
func (l *TemplateLoader) EvalStarlark(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, error)
func (*TemplateLoader) EvalText ¶
func (l *TemplateLoader) EvalText(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, *texttemplate.NodeRoot, error)
func (*TemplateLoader) EvalYAML ¶
func (l *TemplateLoader) EvalYAML(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, *yamlmeta.DocumentSet, error)
func (*TemplateLoader) FindCompiledTemplate ¶
func (l *TemplateLoader) FindCompiledTemplate(path string) (*template.CompiledTemplate, error)
func (*TemplateLoader) Load ¶
func (l *TemplateLoader) Load(thread *starlark.Thread, module string) (starlark.StringDict, error)
func (*TemplateLoader) ParseYAML ¶ added in v0.17.0
func (l *TemplateLoader) ParseYAML(file *files.File) (*yamlmeta.DocumentSet, error)
type TemplateLoaderOpts ¶ added in v0.12.0
type TemplateLoaderOpts struct { IgnoreUnknownComments bool ImplicitMapKeyOverrides bool StrictYAML bool SchemaEnabled bool }
func (TemplateLoaderOpts) Merge ¶ added in v0.31.0
func (opts TemplateLoaderOpts) Merge(overrides TemplateLoaderOptsOverrides) TemplateLoaderOpts
type TemplateLoaderOptsOverrides ¶ added in v0.31.0
Source Files ¶
Click to show internal directories.
Click to hide internal directories.