...

Source file src/k8s.io/cli-runtime/pkg/printers/interface.go

Documentation: k8s.io/cli-runtime/pkg/printers

     1  /*
     2  Copyright 2018 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 printers
    18  
    19  import (
    20  	"io"
    21  
    22  	"k8s.io/apimachinery/pkg/runtime"
    23  	"k8s.io/apimachinery/pkg/runtime/schema"
    24  )
    25  
    26  // ResourcePrinterFunc is a function that can print objects
    27  type ResourcePrinterFunc func(runtime.Object, io.Writer) error
    28  
    29  // PrintObj implements ResourcePrinter
    30  func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error {
    31  	return fn(obj, w)
    32  }
    33  
    34  // ResourcePrinter is an interface that knows how to print runtime objects.
    35  type ResourcePrinter interface {
    36  	// PrintObj receives a runtime object, formats it and prints it to a writer.
    37  	PrintObj(runtime.Object, io.Writer) error
    38  }
    39  
    40  // PrintOptions struct defines a struct for various print options
    41  type PrintOptions struct {
    42  	NoHeaders     bool
    43  	WithNamespace bool
    44  	WithKind      bool
    45  	Wide          bool
    46  	ShowLabels    bool
    47  	Kind          schema.GroupKind
    48  	ColumnLabels  []string
    49  
    50  	SortBy string
    51  
    52  	// indicates if it is OK to ignore missing keys for rendering an output template.
    53  	AllowMissingKeys bool
    54  }
    55  

View as plain text