sigs.k8s.io/kubebuilder/v3@v3.14.0/pkg/machinery/file.go (about)

     1  /*
     2  Copyright 2020 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package machinery
    18  
    19  // IfExistsAction determines what to do if the scaffold file already exists
    20  type IfExistsAction int
    21  
    22  const (
    23  	// SkipFile skips the file and moves to the next one
    24  	SkipFile IfExistsAction = iota
    25  
    26  	// Error returns an error and stops processing
    27  	Error
    28  
    29  	// OverwriteFile truncates and overwrites the existing file
    30  	OverwriteFile
    31  )
    32  
    33  // File describes a file that will be written
    34  type File struct {
    35  	// Path is the file to write
    36  	Path string
    37  
    38  	// Contents is the generated output
    39  	Contents string
    40  
    41  	// IfExistsAction determines what to do if the file exists
    42  	IfExistsAction IfExistsAction
    43  }