types

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 12, 2019 License: Apache-2.0 Imports: 10 Imported by: 267

Documentation

Overview

Package types holds the definition of the kustomization struct and supporting structs. It's the k8s API conformant object that describes a set of generation and transformation operations to create and/or modify k8s resources. A kustomization file is a serialization of this struct.

Index

Constants

View Source 
const (
	KustomizationVersion = "kustomize.config.k8s.io/v1beta1"
	KustomizationKind    = "Kustomization"
)

Variables

This section is empty.

Functions

func FixKustomizationPreUnmarshalling 

func FixKustomizationPreUnmarshalling(data []byte) []byte

FixKustomizationPreUnmarshalling modies the raw data before marshalling - e.g. changes old field names to new field names.

func IsErrOnlyBuiltinPluginsAllowed added in v0.1.2 

func IsErrOnlyBuiltinPluginsAllowed(err error) bool

func IsErrUnableToFind added in v0.1.2 

func IsErrUnableToFind(err error) bool

func NewErrOnlyBuiltinPluginsAllowed added in v0.1.2 

func NewErrOnlyBuiltinPluginsAllowed(n string) *errOnlyBuiltinPluginsAllowed

func NewErrUnableToFind added in v0.1.2 

func NewErrUnableToFind(w string, a []Pair) *errUnableToFind

Types

type ConfigMapArgs 

type ConfigMapArgs struct {
	// GeneratorArgs for the configmap.
	GeneratorArgs `json:",inline,omitempty" yaml:",inline,omitempty"`
}

ConfigMapArgs contains the metadata of how to generate a configmap.

type FieldSelector 

type FieldSelector struct {
	FieldPath string `json:"fieldPath,omitempty" yaml:"fieldPath,omitempty"`
}

FieldSelector contains the fieldPath to an object field. This struct is added to keep the backward compatibility of using ObjectFieldSelector for Var.FieldRef

type FieldSpec 

type FieldSpec struct {
	resid.Gvk          `json:",inline,omitempty" yaml:",inline,omitempty"`
	Path               string `json:"path,omitempty" yaml:"path,omitempty"`
	CreateIfNotPresent bool   `json:"create,omitempty" yaml:"create,omitempty"`
}

FieldSpec completely specifies a kustomizable field in an unstructured representation of a k8s API object. It helps define the operands of transformations.

For example, a directive to add a common label to objects will need to know that a 'Deployment' object (in API group 'apps', any version) can have labels at field path 'spec/template/metadata/labels', and further that it is OK (or not OK) to add that field path to the object if the field path doesn't exist already.

This would look like 

{
  group: apps
  kind: Deployment
  path: spec/template/metadata/labels
  create: true
}

func (FieldSpec) PathSlice 

func (fs FieldSpec) PathSlice() []string

PathSlice converts the path string to a slice of strings, separated by a '/'. Forward slash can be contained in a fieldname. such as ingress.kubernetes.io/auth-secret in Ingress annotations. To deal with this special case, the path to this field should be formatted as 

metadata/annotations/ingress.kubernetes.io\/auth-secret

Then PathSlice will return 

[]string{
   "metadata",
   "annotations",
   "ingress.auth-secretkubernetes.io/auth-secret"
}

func (FieldSpec) String 

func (fs FieldSpec) String() string

type FsSlice 

type FsSlice []FieldSpec

func (FsSlice) Len 

func (s FsSlice) Len() int

func (FsSlice) Less 

func (s FsSlice) Less(i, j int) bool

func (FsSlice) MergeAll 

func (s FsSlice) MergeAll(incoming FsSlice) (result FsSlice, err error)

MergeAll merges the argument into this, returning the result. Items already present are ignored. Items that conflict (primary key matches, but remain data differs) result in an error.

func (FsSlice) MergeOne 

func (s FsSlice) MergeOne(x FieldSpec) (FsSlice, error)

MergeOne merges the argument into this, returning the result. If the item's primary key is already present, and there are no conflicts, it is ignored (we don't want duplicates). If there is a conflict, the merge fails.

func (FsSlice) Swap 

func (s FsSlice) Swap(i, j int)

type GarbagePolicy 

type GarbagePolicy int
const (
	GarbageIgnore GarbagePolicy = iota + 1
	GarbageCollect
)

func (GarbagePolicy) String 

func (i GarbagePolicy) String() string

type GenArgs 

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

GenArgs contains both GeneratorArgs and GeneratorOptions.

func NewGenArgs 

func NewGenArgs(args *GeneratorArgs, opts *GeneratorOptions) *GenArgs

NewGenArgs returns a new object of GenArgs

func (*GenArgs) Behavior 

func (g *GenArgs) Behavior() GenerationBehavior

Behavior returns Behavior field of GeneratorArgs

func (*GenArgs) ShouldAddHashSuffixToName added in v0.3.0 

func (g *GenArgs) ShouldAddHashSuffixToName() bool

ShouldAddHashSuffixToName returns true if a resource content hash should be appended to the name of the resource.

func (*GenArgs) String 

func (g *GenArgs) String() string

type GenerationBehavior 

type GenerationBehavior int

GenerationBehavior specifies generation behavior of configmaps, secrets and maybe other resources. 

const (
	// BehaviorUnspecified is an Unspecified behavior; typically treated as a Create.
	BehaviorUnspecified GenerationBehavior = iota
	// BehaviorCreate makes a new resource.
	BehaviorCreate
	// BehaviorReplace replaces a resource.
	BehaviorReplace
	// BehaviorMerge attempts to merge a new resource with an existing resource.
	BehaviorMerge
)

func NewGenerationBehavior 

func NewGenerationBehavior(s string) GenerationBehavior

NewGenerationBehavior converts a string to a GenerationBehavior.

func (GenerationBehavior) String 

func (b GenerationBehavior) String() string

String converts a GenerationBehavior to a string.

type GeneratorArgs 

type GeneratorArgs struct {
	// Namespace for the configmap, optional
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`

	// Name - actually the partial name - of the generated resource.
	// The full name ends up being something like
	// NamePrefix + this.Name + hash(content of generated resource).
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// Behavior of generated resource, must be one of:
	//   'create': create a new one
	//   'replace': replace the existing one
	//   'merge': merge with the existing one
	Behavior string `json:"behavior,omitempty" yaml:"behavior,omitempty"`

	// KvPairSources for the generator.
	KvPairSources `json:",inline,omitempty" yaml:",inline,omitempty"`
}

GeneratorArgs contains arguments common to ConfigMap and Secret generators.

type GeneratorOptions 

type GeneratorOptions struct {
	// Labels to add to all generated resources.
	Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`

	// Annotations to add to all generated resources.
	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`

	// DisableNameSuffixHash if true disables the default behavior of adding a
	// suffix to the names of generated resources that is a hash of the
	// resource contents.
	DisableNameSuffixHash bool `json:"disableNameSuffixHash,omitempty" yaml:"disableNameSuffixHash,omitempty"`
}

GeneratorOptions modify behavior of all ConfigMap and Secret generators.

type Image 

type Image struct {
	// Name is a tag-less image name.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// NewName is the value used to replace the original name.
	NewName string `json:"newName,omitempty" yaml:"newName,omitempty"`

	// NewTag is the value used to replace the original tag.
	NewTag string `json:"newTag,omitempty" yaml:"newTag,omitempty"`

	// Digest is the value used to replace the original image tag.
	// If digest is present NewTag value is ignored.
	Digest string `json:"digest,omitempty" yaml:"digest,omitempty"`
}

Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.

type Inventory 

type Inventory struct {
	Type      string   `json:"type,omitempty" yaml:"type,omitempty"`
	ConfigMap NameArgs `json:"configMap,omitempty" yaml:"configMap,omitempty"`
}

Inventory records all objects touched in a build operation.

type Kustomization 

type Kustomization struct {
	TypeMeta `json:",inline" yaml:",inline"`

	// NamePrefix will prefix the names of all resources mentioned in the kustomization
	// file including generated configmaps and secrets.
	NamePrefix string `json:"namePrefix,omitempty" yaml:"namePrefix,omitempty"`

	// NameSuffix will suffix the names of all resources mentioned in the kustomization
	// file including generated configmaps and secrets.
	NameSuffix string `json:"nameSuffix,omitempty" yaml:"nameSuffix,omitempty"`

	// Namespace to add to all objects.
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`

	// CommonLabels to add to all objects and selectors.
	CommonLabels map[string]string `json:"commonLabels,omitempty" yaml:"commonLabels,omitempty"`

	// CommonAnnotations to add to all objects.
	CommonAnnotations map[string]string `json:"commonAnnotations,omitempty" yaml:"commonAnnotations,omitempty"`

	// PatchesStrategicMerge specifies the relative path to a file
	// containing a strategic merge patch.  Format documented at
	// https://github.com/kubernetes/community/blob/master/contributors/devel/strategic-merge-patch.md
	// URLs and globs are not supported.
	PatchesStrategicMerge []PatchStrategicMerge `json:"patchesStrategicMerge,omitempty" yaml:"patchesStrategicMerge,omitempty"`

	// JSONPatches is a list of JSONPatch for applying JSON patch.
	// Format documented at https://tools.ietf.org/html/rfc6902
	// and http://jsonpatch.com
	PatchesJson6902 []PatchJson6902 `json:"patchesJson6902,omitempty" yaml:"patchesJson6902,omitempty"`

	// Patches is a list of patches, where each one can be either a
	// Strategic Merge Patch or a JSON patch.
	// Each patch can be applied to multiple target objects.
	Patches []Patch `json:"patches,omitempty" yaml:"patches,omitempty"`

	// Images is a list of (image name, new name, new tag or digest)
	// for changing image names, tags or digests. This can also be achieved with a
	// patch, but this operator is simpler to specify.
	Images []Image `json:"images,omitempty" yaml:"images,omitempty"`

	// Replicas is a list of {resourcename, count} that allows for simpler replica
	// specification. This can also be done with a patch.
	Replicas []Replica `json:"replicas,omitempty" yaml:"replicas,omitempty"`

	// Vars allow things modified by kustomize to be injected into a
	// kubernetes object specification. A var is a name (e.g. FOO) associated
	// with a field in a specific resource instance.  The field must
	// contain a value of type string/bool/int/float, and defaults to the name field
	// of the instance.  Any appearance of "$(FOO)" in the object
	// spec will be replaced at kustomize build time, after the final
	// value of the specified field has been determined.
	Vars []Var `json:"vars,omitempty" yaml:"vars,omitempty"`

	// Resources specifies relative paths to files holding YAML representations
	// of kubernetes API objects, or specifcations of other kustomizations
	// via relative paths, absolute paths, or URLs.
	Resources []string `json:"resources,omitempty" yaml:"resources,omitempty"`

	// Crds specifies relative paths to Custom Resource Definition files.
	// This allows custom resources to be recognized as operands, making
	// it possible to add them to the Resources list.
	// CRDs themselves are not modified.
	Crds []string `json:"crds,omitempty" yaml:"crds,omitempty"`

	// Deprecated.
	// Anything that would have been specified here should
	// be specified in the Resources field instead.
	Bases []string `json:"bases,omitempty" yaml:"bases,omitempty"`

	// ConfigMapGenerator is a list of configmaps to generate from
	// local data (one configMap per list item).
	// The resulting resource is a normal operand, subject to
	// name prefixing, patching, etc.  By default, the name of
	// the map will have a suffix hash generated from its contents.
	ConfigMapGenerator []ConfigMapArgs `json:"configMapGenerator,omitempty" yaml:"configMapGenerator,omitempty"`

	// SecretGenerator is a list of secrets to generate from
	// local data (one secret per list item).
	// The resulting resource is a normal operand, subject to
	// name prefixing, patching, etc.  By default, the name of
	// the map will have a suffix hash generated from its contents.
	SecretGenerator []SecretArgs `json:"secretGenerator,omitempty" yaml:"secretGenerator,omitempty"`

	// GeneratorOptions modify behavior of all ConfigMap and Secret generators.
	GeneratorOptions *GeneratorOptions `json:"generatorOptions,omitempty" yaml:"generatorOptions,omitempty"`

	// Configurations is a list of transformer configuration files
	Configurations []string `json:"configurations,omitempty" yaml:"configurations,omitempty"`

	// Generators is a list of files containing custom generators
	Generators []string `json:"generators,omitempty" yaml:"generators,omitempty"`

	// Transformers is a list of files containing transformers
	Transformers []string `json:"transformers,omitempty" yaml:"transformers,omitempty"`

	// Inventory appends an object that contains the record
	// of all other objects, which can be used in apply, prune and delete
	Inventory *Inventory `json:"inventory,omitempty" yaml:"inventory,omitempty"`
}

Kustomization holds the information needed to generate customized k8s api resources.

func (*Kustomization) EnforceFields 

func (k *Kustomization) EnforceFields() []string

func (*Kustomization) FixKustomizationPostUnmarshalling 

func (k *Kustomization) FixKustomizationPostUnmarshalling()

FixKustomizationPostUnmarshalling fixes things like empty fields that should not be empty, or moving content of deprecated fields to newer fields.

type KvPairSources 

type KvPairSources struct {
	// LiteralSources is a list of literal
	// pair sources. Each literal source should
	// be a key and literal value, e.g. `key=value`
	LiteralSources []string `json:"literals,omitempty" yaml:"literals,omitempty"`

	// FileSources is a list of file "sources" to
	// use in creating a list of key, value pairs.
	// A source takes the form:  [{key}=]{path}
	// If the "key=" part is missing, the key is the
	// path's basename. If they "key=" part is present,
	// it becomes the key (replacing the basename).
	// In either case, the value is the file contents.
	// Specifying a directory will iterate each named
	// file in the directory whose basename is a
	// valid configmap key.
	FileSources []string `json:"files,omitempty" yaml:"files,omitempty"`

	// EnvSources is a list of file paths.
	// The contents of each file should be one
	// key=value pair per line, e.g. a Docker
	// or npm ".env" file or a ".ini" file
	// (wikipedia.org/wiki/INI_file)
	EnvSources []string `json:"envs,omitempty" yaml:"envs,omitempty"`
}

KvPairSources defines places to obtain key value pairs.

type LoadRestrictions added in v0.1.2 

type LoadRestrictions int

Restrictions on what things can be referred to in a kustomization file. 

const (
	LoadRestrictionsUnknown LoadRestrictions = iota

	// Files referenced by a kustomization file must be in
	// or under the directory holding the kustomization
	// file itself.
	LoadRestrictionsRootOnly

	// The kustomization file may specify absolute or
	// relative paths to patch or resources files outside
	// its own tree.
	LoadRestrictionsNone
)

func (LoadRestrictions) String added in v0.1.2 

func (i LoadRestrictions) String() string

type NameArgs 

type NameArgs struct {
	Name      string `json:"name,omitempty" yaml:"name,omitempty"`
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
}

NameArgs holds both namespace and name.

type ObjectMeta 

type ObjectMeta struct {
	Name      string `json:"name,omitempty" yaml:"name,omitempty"`
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
}

ObjectMeta partially copies apimachinery/pkg/apis/meta/v1.ObjectMeta No need for a direct dependence; the fields are stable.

type Pair 

type Pair struct {
	Key   string
	Value string
}

Pair is a key value pair.

type Patch 

type Patch struct {
	// Path is a relative file path to the patch file.
	Path string `json:"path,omitempty" yaml:"path,omitempty"`

	// Patch is the content of a patch.
	Patch string `json:"patch,omitempty" yaml:"patch,omitempty"`

	// Target points to the resources that the patch is applied to
	Target *Selector `json:"target,omitempty" yaml:"target,omitempty"`
}

Patch represent either a Strategic Merge Patch or a JSON patch and its targets. The content of the patch can either be from a file or from an inline string.

type PatchJson6902 

type PatchJson6902 struct {
	// PatchTarget refers to a Kubernetes object that the json patch will be
	// applied to. It must refer to a Kubernetes resource under the
	// purview of this kustomization. PatchTarget should use the
	// raw name of the object (the name specified in its YAML,
	// before addition of a namePrefix and a nameSuffix).
	Target *PatchTarget `json:"target" yaml:"target"`

	// relative file path for a json patch file inside a kustomization
	Path string `json:"path,omitempty" yaml:"path,omitempty"`

	// inline patch string
	Patch string `json:"patch,omitempty" yaml:"patch,omitempty"`
}

PatchJson6902 represents a json patch for an object with format documented https://tools.ietf.org/html/rfc6902.

type PatchStrategicMerge 

type PatchStrategicMerge string

PatchStrategicMerge represents a relative path to a stategic merge patch with the format https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md

type PatchTarget 

type PatchTarget struct {
	resid.Gvk `json:",inline,omitempty" yaml:",inline,omitempty"`
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
	Name      string `json:"name" yaml:"name"`
}

PatchTarget represents the kubernetes object that the patch is applied to

type PluginConfig 

type PluginConfig struct {
	// AbsPluginHome is the home of kustomize plugins.
	// Kustomize plugin configuration files are k8s-style objects
	// containing the fields 'apiVersion' and 'kind', e.g.
	//   apiVersion: apps/v1
	//   kind: Deployment
	// When kustomize reads a plugin configuration file (as as result
	// of seeing the file name in the 'generators:' or 'transformers:'
	// field in a kustomization file), it must then locate the plugin
	// code (Go plugin or exec plugin).
	// Every kustomize plugin (its code, its tests, supporting data
	// files, etc.) must be housed in its own directory at
	//   ${AbsPluginHome}/${pluginApiVersion}/LOWERCASE(${pluginKind})
	// where
	//   - ${AbsPluginHome} is an absolute path, defined below.
	//   - ${pluginApiVersion} is taken from the plugin config file.
	//   - ${pluginKind} is taken from the plugin config file.
	// The value of AbsPluginHome can be any absolute path, but might
	// default to $XDG_CONFIG_HOME/kustomize/plugin.
	AbsPluginHome string

	// PluginRestrictions defines the plugin restriction state.
	// See type for more information.
	PluginRestrictions PluginRestrictions
}

PluginConfig holds plugin configuration.

type PluginRestrictions added in v0.1.2 

type PluginRestrictions int

Some plugin classes

  • builtin: plugins defined in the kustomize repo. May be freely used and re-configured.
  • local: plugins that aren't builtin but are locally defined (presumably by the user), meaning the kustomization refers to them via a relative file path, not a URL.
  • remote: require a build-time download to obtain. Unadvised, unless one controls the serving site.
const (
	PluginRestrictionsUnknown PluginRestrictions = iota

	// Non-builtin plugins completely disabled.
	PluginRestrictionsBuiltinsOnly

	// No restrictions, do whatever you want.
	PluginRestrictionsNone
)

func (PluginRestrictions) String added in v0.1.2 

func (i PluginRestrictions) String() string

type ReplSource added in v0.3.0 

type ReplSource struct {
	ObjRef   *Target `json:"objref,omitempty" yaml:"objref,omitempty"`
	FieldRef string  `json:"fieldref,omitempty" yaml:"fiedldref,omitempty"`
	Value    string  `json:"value,omitempty" yaml:"value,omitempty"`
}

ReplSource defines where a substitution is from It can from two different kinds of sources

  • from a field of one resource
  • from a string

type ReplTarget added in v0.3.0 

type ReplTarget struct {
	ObjRef    *Selector `json:"objref,omitempty" yaml:"objref,omitempty"`
	FieldRefs []string  `json:"fieldrefs,omitempty" yaml:"fieldrefs,omitempty"`
}

ReplTarget defines where a substitution is to.

type Replacement added in v0.3.0 

type Replacement struct {
	Source *ReplSource `json:"source" yaml:"source"`
	Target *ReplTarget `json:"target" yaml:"target"`
}

Replacement defines how to perform a substitution where it is from and where it is to.

type Replica 

type Replica struct {
	// The name of the resource to change the replica count
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// The number of replicas required.
	Count int64 `json:"count" yaml:"count"`
}

Replica specifies a modification to a replica config. The number of replicas of a resource whose name matches will be set to count. This struct is used by the ReplicaCountTransform, and is meant to supplement the existing patch functionality with a simpler syntax for replica configuration.

type SecretArgs 

type SecretArgs struct {
	// GeneratorArgs for the secret.
	GeneratorArgs `json:",inline,omitempty" yaml:",inline,omitempty"`

	// Type of the secret.
	//
	// This is the same field as the secret type field in v1/Secret:
	// It can be "Opaque" (default), or "kubernetes.io/tls".
	//
	// If type is "kubernetes.io/tls", then "literals" or "files" must have exactly two
	// keys: "tls.key" and "tls.crt"
	Type string `json:"type,omitempty" yaml:"type,omitempty"`
}

SecretArgs contains the metadata of how to generate a secret.

type Selector 

type Selector struct {
	resid.Gvk `json:",inline,omitempty" yaml:",inline,omitempty"`
	Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
	Name      string `json:"name,omitempty" yaml:"name,omitempty"`

	// AnnotationSelector is a string that follows the label selection expression
	// https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
	// It matches with the resource annotations.
	AnnotationSelector string `json:"annotationSelector,omitempty" yaml:"annotationSelector,omitempty"`

	// LabelSelector is a string that follows the label selection expression
	// https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api
	// It matches with the resource labels.
	LabelSelector string `json:"labelSelector,omitempty" yaml:"labelSelector,omitempty"`
}

Selector specifies a set of resources. Any resource that matches intersection of all conditions is included in this set.

type Target 

type Target struct {
	APIVersion string `json:"apiVersion,omitempty" yaml:"apiVersion,omitempty"`
	resid.Gvk  `json:",inline,omitempty" yaml:",inline,omitempty"`
	Name       string `json:"name" yaml:"name"`
	Namespace  string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
}

Target refers to a kubernetes object by Group, Version, Kind and Name gvk.Gvk contains Group, Version and Kind APIVersion is added to keep the backward compatibility of using ObjectReference for Var.ObjRef

func (*Target) GVK 

func (t *Target) GVK() resid.Gvk

GVK returns the Gvk object in Target

type TypeMeta 

type TypeMeta struct {
	Kind       string `json:"kind,omitempty" yaml:"kind,omitempty"`
	APIVersion string `json:"apiVersion,omitempty" yaml:"apiVersion,omitempty"`
}

TypeMeta partially copies apimachinery/pkg/apis/meta/v1.TypeMeta No need for a direct dependence; the fields are stable.

type Var 

type Var struct {
	// Value of identifier name e.g. FOO used in container args, annotations
	// Appears in pod template as $(FOO)
	Name string `json:"name" yaml:"name"`

	// ObjRef must refer to a Kubernetes resource under the
	// purview of this kustomization. ObjRef should use the
	// raw name of the object (the name specified in its YAML,
	// before addition of a namePrefix and a nameSuffix).
	ObjRef Target `json:"objref" yaml:"objref"`

	// FieldRef refers to the field of the object referred to by
	// ObjRef whose value will be extracted for use in
	// replacing $(FOO).
	// If unspecified, this defaults to fieldPath: $defaultFieldPath
	FieldRef FieldSelector `json:"fieldref,omitempty" yaml:"fieldref,omitempty"`
}

Var represents a variable whose value will be sourced from a field in a Kubernetes object.

func (Var) DeepEqual 

func (v Var) DeepEqual(other Var) bool

DeepEqual returns true if var a and b are Equals. Note 1: The objects are unchanged by the VarEqual Note 2: Should be normalize be FieldPath before doing the DeepEqual. spec.a[b] is supposed to be the same as spec.a.b

func (*Var) Defaulting 

func (v *Var) Defaulting()

defaulting sets reference to field used by default.

type VarSet 

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

VarSet is a set of Vars where no var.Name is repeated.

func NewVarSet 

func NewVarSet() VarSet

NewVarSet returns an initialized VarSet

func (*VarSet) Absorb 

func (vs *VarSet) Absorb(v Var) error

Absorb absorbs another Var with error on (name,value) collision. Empty fields in incoming Var is defaulted.

func (*VarSet) AbsorbSet 

func (vs *VarSet) AbsorbSet(incoming VarSet) error

AbsorbSet absorbs other vars with error on (name,value) collision.

func (*VarSet) AbsorbSlice 

func (vs *VarSet) AbsorbSlice(incoming []Var) error

AbsorbSlice absorbs a Var slice with error on (name,value) collision. Empty fields in incoming vars are defaulted.

func (*VarSet) AsSlice 

func (vs *VarSet) AsSlice() []Var

AsSlice returns the vars as a slice.

func (*VarSet) Contains 

func (vs *VarSet) Contains(other Var) bool

Contains is true if the set has the other var.

func (*VarSet) Copy 

func (vs *VarSet) Copy() VarSet

Copy returns a copy of the var set.

func (*VarSet) Get 

func (vs *VarSet) Get(name string) *Var

Get returns the var with the given name, else nil.

func (*VarSet) Merge 

func (vs *VarSet) Merge(v Var) error

Merge absorbs another Var with error on name collision. Empty fields in incoming Var is defaulted.

func (*VarSet) MergeSet 

func (vs *VarSet) MergeSet(incoming VarSet) error

MergeSet absorbs other vars with error on name collision.

func (*VarSet) MergeSlice 

func (vs *VarSet) MergeSlice(incoming []Var) error

MergeSlice absorbs a Var slice with error on name collision. Empty fields in incoming vars are defaulted.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.