Documentation ¶
Overview ¶
deepcopy-gen is a tool for auto-generating DeepCopy functions.
Given a list of input directories, it will generate DeepCopy and DeepCopyInto methods that efficiently perform a full deep-copy of each type. If these already exist (are predefined by the developer), they are used instead of generating new ones.
If interfaces are referenced in types, it is expected that corresponding DeepCopyInterfaceName methods exist, e.g. DeepCopyObject for runtime.Object. These can be predefined by the developer or generated through tags, see below. They must be added to the interfaces themselves manually, e.g.
type Object interface { ... DeepCopyObject() Object }
All generation is governed by comment tags in the source. Any package may request DeepCopy generation by including a comment in the file-comments of a doc.go file, of the form:
// +deepcopy-gen=package
DeepCopy functions can be generated for individual types, rather than the entire package by specifying a comment on the type definion of the form:
// +deepcopy-gen=true
When generating for a whole package, individual types may opt out of DeepCopy generation by specifying a comment on the type definition of the form:
// +deepcopy-gen=false
Additional DeepCopyInterfaceName methods can be generated by specifying a comment on the type definition of the form:
// +deepcopy-gen:interfaces=k8s.io/kubernetes/runtime.Object,k8s.io/kubernetes/runtime.List
This leads to the generation of DeepCopyObject and DeepCopyList with the given interfaces as return types. We say that the tagged type implements deepcopy for the interfaces.
The deepcopy funcs for interfaces using "+deepcopy-gen:interfaces" use the pointer of the type as receiver. For those special cases where the non-pointer object should implement the interface, this can be done with:
// +deepcopy-gen:nonpointer-interfaces=true
Directories ¶
Path | Synopsis |
---|---|
Package args has common command-line flags for generation programs.
|
Package args has common command-line flags for generation programs. |
Package generator defines an interface for code generators to implement.
|
Package generator defines an interface for code generators to implement. |
Package namer has support for making different type naming systems.
|
Package namer has support for making different type naming systems. |
Package parser provides code to parse go files, type-check them, extract the types.
|
Package parser provides code to parse go files, type-check them, extract the types. |
Package sets has auto-generated set types.
|
Package sets has auto-generated set types. |
types
Package types just provides input types to the set generator.
|
Package types just provides input types to the set generator. |
Package types contains go type information, packaged in a way that makes auto-generation convenient, whether by template or straight go functions.
|
Package types contains go type information, packaged in a way that makes auto-generation convenient, whether by template or straight go functions. |