marker

Documentation

Overview

This is a test package.

Index

• Constants
• func RegisterDefaults(scheme *runtime.Scheme) error
• func SetDefaults_DefaultedWithFunction(obj *DefaultedWithFunction)
• func SetObjectDefaults_Defaulted(in *Defaulted)
• func SetObjectDefaults_DefaultedOmitempty(in *DefaultedOmitempty)
• func SetObjectDefaults_DefaultedWithFunction(in *DefaultedWithFunction)
• func SetObjectDefaults_DefaultedWithReference(in *DefaultedWithReference)
• type B0
• type B1
• type B2
• type B3
• type B4
• type Defaulted
  • func (in *Defaulted) DeepCopy() *Defaulted
  • func (in *Defaulted) DeepCopyInto(out *Defaulted)
  • func (in *Defaulted) DeepCopyObject() runtime.Object
  • func (in *Defaulted) GetObjectKind() schema.ObjectKind
• type DefaultedOmitempty
  • func (in *DefaultedOmitempty) DeepCopy() *DefaultedOmitempty
  • func (in *DefaultedOmitempty) DeepCopyInto(out *DefaultedOmitempty)
  • func (in *DefaultedOmitempty) DeepCopyObject() runtime.Object
  • func (in *DefaultedOmitempty) GetObjectKind() schema.ObjectKind
• type DefaultedValueItem
• type DefaultedWithFunction
  • func (in *DefaultedWithFunction) DeepCopy() *DefaultedWithFunction
  • func (in *DefaultedWithFunction) DeepCopyInto(out *DefaultedWithFunction)
  • func (in *DefaultedWithFunction) DeepCopyObject() runtime.Object
  • func (in *DefaultedWithFunction) GetObjectKind() schema.ObjectKind
• type DefaultedWithReference
  • func (in *DefaultedWithReference) DeepCopy() *DefaultedWithReference
  • func (in *DefaultedWithReference) DeepCopyInto(out *DefaultedWithReference)
  • func (in *DefaultedWithReference) DeepCopyObject() runtime.Object
  • func (in *DefaultedWithReference) GetObjectKind() schema.ObjectKind
• type Item
• type ItemDefaultWiped
• type PointerValueItem
• type SubStruct
• type ValueItem

Constants

const SomeDefault = "ACoolConstant"

Functions

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func SetDefaults_DefaultedWithFunction

func SetDefaults_DefaultedWithFunction(obj *DefaultedWithFunction)

func SetObjectDefaults_Defaulted

func SetObjectDefaults_Defaulted(in *Defaulted)

func SetObjectDefaults_DefaultedOmitempty

func SetObjectDefaults_DefaultedOmitempty(in *DefaultedOmitempty)

func SetObjectDefaults_DefaultedWithFunction

func SetObjectDefaults_DefaultedWithFunction(in *DefaultedWithFunction)

func SetObjectDefaults_DefaultedWithReference

func SetObjectDefaults_DefaultedWithReference(in *DefaultedWithReference)

Types

type B0

type B0 *string

Super complicated hierarchy of aliases which includes multiple pointers, and sibling types.

type B1

type B1 B0

type B2

type B2 *B1

type B3

type B3 ****B2

type B4

type B4 **B3

type Defaulted

type Defaulted struct {
	empty.TypeMeta

	// +default="bar"
	StringDefault string

	// Default is forced to empty string
	// Specifying the default is a no-op
	// +default=""
	StringEmptyDefault string

	// Not specifying a default still defaults for non-omitempty
	StringEmpty string

	// +default="default"
	StringPointer *string

	// +default=64
	Int64 *int64

	// +default=32
	Int32 *int32

	// +default=1
	IntDefault int

	// +default=0
	IntEmptyDefault int

	// Default is forced to 0
	IntEmpty int

	// +default=0.5
	FloatDefault float64

	// +default=0.0
	FloatEmptyDefault float64

	FloatEmpty float64

	// +default=["foo", "bar"]
	List []Item
	// +default={"s": "foo", "i": 5}
	Sub *SubStruct

	//+default=[{"s": "foo1", "i": 1}, {"s": "foo2"}]
	StructList []SubStruct

	//+default=[{"s": "foo1", "i": 1}, {"s": "foo2"}]
	PtrStructList []*SubStruct

	//+default=["foo"]
	StringList []string

	// Default is forced to empty struct
	OtherSub SubStruct

	// +default={"foo": "bar"}
	Map map[string]Item

	// +default={"foo": {"S": "string", "I": 1}}
	StructMap map[string]SubStruct

	// +default={"foo": {"S": "string", "I": 1}}
	PtrStructMap map[string]*SubStruct

	// A default specified here overrides the default for the Item type
	// +default="banana"
	AliasPtr Item
}

func (*Defaulted) DeepCopy

func (in *Defaulted) DeepCopy() *Defaulted

func (*Defaulted) DeepCopyInto

func (in *Defaulted) DeepCopyInto(out *Defaulted)

func (*Defaulted) DeepCopyObject

func (in *Defaulted) DeepCopyObject() runtime.Object

func (*Defaulted) GetObjectKind

func (in *Defaulted) GetObjectKind() schema.ObjectKind

type DefaultedOmitempty

type DefaultedOmitempty struct {
	empty.TypeMeta `json:",omitempty"`

	// +default="bar"
	StringDefault string `json:",omitempty"`

	// Default is forced to empty string
	// Specifying the default is a no-op
	// +default=""
	StringEmptyDefault string `json:",omitempty"`

	// Not specifying a default still defaults for non-omitempty
	StringEmpty string `json:",omitempty"`

	// +default="default"
	StringPointer *string `json:",omitempty"`

	// +default=64
	Int64 *int64 `json:",omitempty"`

	// +default=32
	Int32 *int32 `json:",omitempty"`

	// +default=1
	IntDefault int `json:",omitempty"`

	// +default=0
	IntEmptyDefault int `json:",omitempty"`

	// Default is forced to 0
	IntEmpty int `json:",omitempty"`

	// +default=0.5
	FloatDefault float64 `json:",omitempty"`

	// +default=0.0
	FloatEmptyDefault float64 `json:",omitempty"`

	FloatEmpty float64 `json:",omitempty"`

	// +default=["foo", "bar"]
	List []Item `json:",omitempty"`
	// +default={"s": "foo", "i": 5}
	Sub *SubStruct `json:",omitempty"`

	//+default=[{"s": "foo1", "i": 1}, {"s": "foo2"}]
	StructList []SubStruct `json:",omitempty"`

	//+default=[{"s": "foo1", "i": 1}, {"s": "foo2"}]
	PtrStructList []*SubStruct `json:",omitempty"`

	//+default=["foo"]
	StringList []string `json:",omitempty"`

	// Default is forced to empty struct
	OtherSub SubStruct `json:",omitempty"`

	// +default={"foo": "bar"}
	Map map[string]Item `json:",omitempty"`

	// +default={"foo": {"S": "string", "I": 1}}
	StructMap map[string]SubStruct `json:",omitempty"`

	// +default={"foo": {"S": "string", "I": 1}}
	PtrStructMap map[string]*SubStruct `json:",omitempty"`

	// A default specified here overrides the default for the Item type
	// +default="banana"
	AliasPtr Item `json:",omitempty"`
}

func (*DefaultedOmitempty) DeepCopy

func (in *DefaultedOmitempty) DeepCopy() *DefaultedOmitempty

func (*DefaultedOmitempty) DeepCopyInto

func (in *DefaultedOmitempty) DeepCopyInto(out *DefaultedOmitempty)

func (*DefaultedOmitempty) DeepCopyObject

func (in *DefaultedOmitempty) DeepCopyObject() runtime.Object

func (*DefaultedOmitempty) GetObjectKind

func (in *DefaultedOmitempty) GetObjectKind() schema.ObjectKind

type DefaultedValueItem

type DefaultedValueItem ValueItem

+default=ref(SomeValue)

type DefaultedWithFunction

type DefaultedWithFunction struct {
	empty.TypeMeta
	// +default="default_marker"
	S1 string `json:"S1,omitempty"`
	// +default="default_marker"
	S2 string `json:"S2,omitempty"`
}

func (*DefaultedWithFunction) DeepCopy

func (in *DefaultedWithFunction) DeepCopy() *DefaultedWithFunction

func (*DefaultedWithFunction) DeepCopyInto

func (in *DefaultedWithFunction) DeepCopyInto(out *DefaultedWithFunction)

func (*DefaultedWithFunction) DeepCopyObject

func (in *DefaultedWithFunction) DeepCopyObject() runtime.Object

func (*DefaultedWithFunction) GetObjectKind

func (in *DefaultedWithFunction) GetObjectKind() schema.ObjectKind

type DefaultedWithReference

type DefaultedWithReference struct {
	empty.TypeMeta

	// Shows that if we have an alias that is a pointer and have a default
	// that is a value convertible to that pointer we can still use it
	// +default=ref(SomeValue)
	AliasConvertDefaultPointer PointerValueItem

	// Shows that default defined on a nested type is not respected through
	// an alias
	AliasWipedDefault ItemDefaultWiped

	// A default defined on a pointer-valued alias is respected
	PointerAliasDefault Item

	// Can have alias that is a pointer to type of constant
	// +default=ref(SomeDefault)
	AliasPointerInside Item

	// Can override default specified on an alias
	// +default=ref(SomeDefault)
	AliasOverride Item

	// Type-level default is not respected unless a pointer
	AliasNonPointerDefault DefaultedValueItem `json:",omitempty"`

	// Type-level default is not respected unless a pointer
	AliasPointerDefault *DefaultedValueItem

	// Can have value typed alias
	// +default=ref(SomeValue)
	AliasNonPointer ValueItem `json:",omitempty"`

	// Can have a pointer to an alias whose default is a non-pointer value
	// +default=ref(SomeValue)
	AliasPointer *ValueItem `json:",omitempty"`

	// Basic ref usage example
	// +default=ref(SomeDefault)
	SymbolReference string `json:",omitempty"`

	// +default=ref(k8s.io/code-generator/cmd/defaulter-gen/output_tests/marker/external.AConstant)
	SameNamePackageSymbolReference1 string `json:",omitempty"`

	// +default=ref(k8s.io/code-generator/cmd/defaulter-gen/output_tests/marker/external/external.AnotherConstant)
	SameNamePackageSymbolReference2 string `json:",omitempty"`

	// Should convert ValueItem -> string then up to B4 through addressOf and
	// casting
	// +default=ref(SomeValue)
	PointerConversion *B4

	// +default=ref(SomeValue)
	PointerConversionValue B4

	// +default=ref(k8s.io/code-generator/cmd/defaulter-gen/output_tests/marker.SomeValue)
	FullyQualifiedLocalSymbol string

	// Construction of external3.StringPointer requires importing external2
	// Test that generator can handle it
	// +default=ref(SomeValue)
	ImportFromAliasCast external3.StringPointer
}

func (*DefaultedWithReference) DeepCopy

func (in *DefaultedWithReference) DeepCopy() *DefaultedWithReference

func (*DefaultedWithReference) DeepCopyInto

func (in *DefaultedWithReference) DeepCopyInto(out *DefaultedWithReference)

func (*DefaultedWithReference) DeepCopyObject

func (in *DefaultedWithReference) DeepCopyObject() runtime.Object

func (*DefaultedWithReference) GetObjectKind

func (in *DefaultedWithReference) GetObjectKind() schema.ObjectKind

type Item

type Item *string

+default="apple"

type ItemDefaultWiped

type ItemDefaultWiped Item

type PointerValueItem

type PointerValueItem *DefaultedValueItem

type SubStruct

type SubStruct struct {
	S string
	// +default=1
	I int `json:"I,omitempty"`
}

type ValueItem

type ValueItem string

const SomeValue ValueItem = "Value"