overlay

Documentation

Index

• Constants
• Variables
• type ArrayItemMatchAnnotation
  • func NewArrayItemMatchAnnotation(newItem *yamlmeta.ArrayItem, defaults MatchChildDefaultsAnnotation, ...) (ArrayItemMatchAnnotation, error)
  • func (a ArrayItemMatchAnnotation) Indexes(leftArray *yamlmeta.Array) ([]int, error)
  • func (a ArrayItemMatchAnnotation) MatchNodes(leftArray *yamlmeta.Array) ([]int, error)
• type DocumentMatchAnnotation
  • func NewDocumentMatchAnnotation(newDoc *yamlmeta.Document, defaults MatchChildDefaultsAnnotation, ...) (DocumentMatchAnnotation, error)
  • func (a DocumentMatchAnnotation) IndexTuples(leftDocSets []*yamlmeta.DocumentSet) ([][]int, error)
  • func (a DocumentMatchAnnotation) MatchNodes(leftDocSets []*yamlmeta.DocumentSet) ([][]int, error)
• type InsertAnnotation
  • func NewInsertAnnotation(newItem template.EvaluationNode) (InsertAnnotation, error)
  • func (a InsertAnnotation) IsAfter() bool
  • func (a InsertAnnotation) IsBefore() bool
• type MapItemMatchAnnotation
  • func NewMapItemMatchAnnotation(newItem *yamlmeta.MapItem, defaults MatchChildDefaultsAnnotation, ...) (MapItemMatchAnnotation, error)
  • func (a MapItemMatchAnnotation) Index(leftMap *yamlmeta.Map) (int, bool, error)
  • func (a MapItemMatchAnnotation) MatchNode(leftMap *yamlmeta.Map) (int, bool)
• type MatchAnnotationExpectsKwarg
  • func (a MatchAnnotationExpectsKwarg) Check(num int) error
  • func (a *MatchAnnotationExpectsKwarg) FillInDefaults(defaults MatchChildDefaultsAnnotation)
• type MatchChildDefaultsAnnotation
  • func NewEmptyMatchChildDefaultsAnnotation() MatchChildDefaultsAnnotation
  • func NewMatchChildDefaultsAnnotation(node template.EvaluationNode, ...) (MatchChildDefaultsAnnotation, error)
• type OverlayOp
  • func (o OverlayOp) Apply() (interface{}, error)
• type ReplaceAnnotation
  • func NewReplaceAnnotation(newNode template.EvaluationNode, thread *starlark.Thread) (ReplaceAnnotation, error)
  • func (a ReplaceAnnotation) Value(existingNode template.EvaluationNode) (interface{}, error)

Constants

const (
	AnnotationNs structmeta.AnnotationNs = "overlay"

	AnnotationMerge   structmeta.AnnotationName = "overlay/merge" // default
	AnnotationRemove  structmeta.AnnotationName = "overlay/remove"
	AnnotationReplace structmeta.AnnotationName = "overlay/replace"
	AnnotationInsert  structmeta.AnnotationName = "overlay/insert" // array only
	AnnotationAppend  structmeta.AnnotationName = "overlay/append" // array only

	AnnotationMatch              structmeta.AnnotationName = "overlay/match"
	AnnotationMatchChildDefaults structmeta.AnnotationName = "overlay/match-child-defaults"
)

Variables

var (
	API = starlark.StringDict{
		"overlay": &starlarkstruct.Module{
			Name: "overlay",
			Members: starlark.StringDict{
				"apply":   starlark.NewBuiltin("overlay.apply", core.ErrWrapper(overlayModule{}.Apply)),
				"index":   starlark.NewBuiltin("overlay.index", core.ErrWrapper(overlayModule{}.Index)),
				"all":     starlark.NewBuiltin("overlay.all", core.ErrWrapper(overlayModule{}.All)),
				"map_key": starlark.NewBuiltin("overlay.map_key", core.ErrWrapper(overlayModule{}.MapKey)),
				"subset":  starlark.NewBuiltin("overlay.subset", core.ErrWrapper(overlayModule{}.Subset)),
			},
		},
	}
)

Types

type ArrayItemMatchAnnotation

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

func NewArrayItemMatchAnnotation

func NewArrayItemMatchAnnotation(newItem *yamlmeta.ArrayItem,
	defaults MatchChildDefaultsAnnotation,
	thread *starlark.Thread) (ArrayItemMatchAnnotation, error)

func (ArrayItemMatchAnnotation) Indexes

func (a ArrayItemMatchAnnotation) Indexes(leftArray *yamlmeta.Array) ([]int, error)

func (ArrayItemMatchAnnotation) MatchNodes

func (a ArrayItemMatchAnnotation) MatchNodes(leftArray *yamlmeta.Array) ([]int, error)

type DocumentMatchAnnotation

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

func NewDocumentMatchAnnotation

func NewDocumentMatchAnnotation(newDoc *yamlmeta.Document,
	defaults MatchChildDefaultsAnnotation,
	thread *starlark.Thread) (DocumentMatchAnnotation, error)

func (DocumentMatchAnnotation) IndexTuples

func (a DocumentMatchAnnotation) IndexTuples(leftDocSets []*yamlmeta.DocumentSet) ([][]int, error)

func (DocumentMatchAnnotation) MatchNodes

func (a DocumentMatchAnnotation) MatchNodes(leftDocSets []*yamlmeta.DocumentSet) ([][]int, error)

type InsertAnnotation

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

func NewInsertAnnotation

func NewInsertAnnotation(newItem template.EvaluationNode) (InsertAnnotation, error)

func (InsertAnnotation) IsAfter

func (a InsertAnnotation) IsAfter() bool

func (InsertAnnotation) IsBefore

func (a InsertAnnotation) IsBefore() bool

type MapItemMatchAnnotation

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

func NewMapItemMatchAnnotation

func NewMapItemMatchAnnotation(newItem *yamlmeta.MapItem,
	defaults MatchChildDefaultsAnnotation,
	thread *starlark.Thread) (MapItemMatchAnnotation, error)

func (MapItemMatchAnnotation) Index

func (a MapItemMatchAnnotation) Index(leftMap *yamlmeta.Map) (int, bool, error)

func (MapItemMatchAnnotation) MatchNode

func (a MapItemMatchAnnotation) MatchNode(leftMap *yamlmeta.Map) (int, bool)

type MatchAnnotationExpectsKwarg

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

func (MatchAnnotationExpectsKwarg) Check

func (a MatchAnnotationExpectsKwarg) Check(num int) error

func (*MatchAnnotationExpectsKwarg) FillInDefaults

func (a *MatchAnnotationExpectsKwarg) FillInDefaults(defaults MatchChildDefaultsAnnotation)

type MatchChildDefaultsAnnotation

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

func NewEmptyMatchChildDefaultsAnnotation

func NewEmptyMatchChildDefaultsAnnotation() MatchChildDefaultsAnnotation

func NewMatchChildDefaultsAnnotation

func NewMatchChildDefaultsAnnotation(node template.EvaluationNode,
	parentMatchChildDefaults MatchChildDefaultsAnnotation) (MatchChildDefaultsAnnotation, error)

type OverlayOp

type OverlayOp struct {
	Left  interface{}
	Right interface{}

	Thread *starlark.Thread
}

func (OverlayOp) Apply

func (o OverlayOp) Apply() (interface{}, error)

type ReplaceAnnotation

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

func NewReplaceAnnotation

func NewReplaceAnnotation(newNode template.EvaluationNode, thread *starlark.Thread) (ReplaceAnnotation, error)

func (ReplaceAnnotation) Value

func (a ReplaceAnnotation) Value(existingNode template.EvaluationNode) (interface{}, error)