deepcopy

Documentation

Index

• Constants
• func NewGenerator(opts Options) generation.Generator
• type Options

Constants

const (
	// DefaultOutputFileBaseName is the default output file base name for the generated deepcopy functions.
	DefaultOutputFileBaseName = "zz_generated.deepcopy"
)

Functions

func NewGenerator

func NewGenerator(opts Options) generation.Generator

NewGenerator builds a new deepcopy generator.

Types

type Options

type Options struct {
	// Disabled indicates whether the deepcopy generator is enabled or not.
	// This default to false as the deepcopy generator is enabled by default.
	Disabled bool

	// HeaderFilePath is the path to the file containing the boilerplate header text.
	// When omitted, no header is added to the generated files.
	HeaderFilePath string

	// OutputFileBaseName is the base name of the output file.
	// When omitted, DefaultOutputFileBaseName is used.
	// The current value of DefaultOutputFileBaseName is "zz_generated.deepcopy".
	OutputFileBaseName string

	// Verify determines whether the generator should verify the content instead
	// of updating the generated file.
	Verify bool
}

Options contains the configuration required for the compatibility generator.