printers

Documentation

Index

• func GetNewTabWriter(output io.Writer) *tabwriter.Writer
• func ValidateRowPrintHandlerFunc(printFunc reflect.Value) error
• type GenerateOptions
• type HumanReadableGenerator
  • func NewTableGenerator() *HumanReadableGenerator
  • func (h *HumanReadableGenerator) GenerateTable(obj runtime.Object, options GenerateOptions) (*metav1beta1.Table, error)
  • func (h *HumanReadableGenerator) TableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error
  • func (h *HumanReadableGenerator) With(fns ...func(PrintHandler)) *HumanReadableGenerator
• type HumanReadablePrinter
  • func (h *HumanReadablePrinter) PrintObj(obj runtime.Object, output io.Writer) error
• type PrintHandler
• type PrintOptions
• type ResourcePrinter
  • func NewTablePrinter(options PrintOptions) ResourcePrinter
• type ResourcePrinterFunc
  • func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error
• type TableGenerator

Functions

func GetNewTabWriter

func GetNewTabWriter(output io.Writer) *tabwriter.Writer

GetNewTabWriter returns a tabwriter that translates tabbed columns in input into properly aligned text.

func ValidateRowPrintHandlerFunc

func ValidateRowPrintHandlerFunc(printFunc reflect.Value) error

ValidateRowPrintHandlerFunc validates print handler signature. printFunc is the function that will be called to print an object. It must be of the following type:

func printFunc(object ObjectType, options GenerateOptions) ([]metav1beta1.TableRow, error)

where ObjectType is the type of the object that will be printed, and the first return value is an array of rows, with each row containing a number of cells that match the number of columns defined for that printer function.

Types

type GenerateOptions

type GenerateOptions struct {
	NoHeaders bool
	Wide      bool
}

GenerateOptions encapsulates attributes for table generation.

type HumanReadableGenerator

type HumanReadableGenerator struct {
	// contains filtered or unexported fields
}

HumanReadableGenerator is an implementation of TableGenerator used to generate a table for a specific resource. The table is printed with a TablePrinter using PrintObj().

func NewTableGenerator

func NewTableGenerator() *HumanReadableGenerator

NewTableGenerator creates a HumanReadableGenerator suitable for calling GenerateTable().

func (*HumanReadableGenerator) GenerateTable

func (h *HumanReadableGenerator) GenerateTable(obj runtime.Object, options GenerateOptions) (*metav1beta1.Table, error)

GenerateTable returns a table for the provided object, using the printer registered for that type. It returns a table that includes all of the information requested by options, but will not remove rows or columns. The caller is responsible for applying rules related to filtering rows or columns.

func (*HumanReadableGenerator) TableHandler

func (h *HumanReadableGenerator) TableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error

TableHandler adds a print handler with a given set of columns to HumanReadableGenerator instance. See ValidateRowPrintHandlerFunc for required method signature.

func (*HumanReadableGenerator) With

func (h *HumanReadableGenerator) With(fns ...func(PrintHandler)) *HumanReadableGenerator

With method - accepts a list of builder functions that modify HumanReadableGenerator

type HumanReadablePrinter

type HumanReadablePrinter struct {
	// contains filtered or unexported fields
}

HumanReadablePrinter is an implementation of ResourcePrinter which attempts to provide more elegant output. It is not threadsafe, but you may call PrintObj repeatedly; headers will only be printed if the object type changes. This makes it useful for printing items received from watches.

func (*HumanReadablePrinter) PrintObj

func (h *HumanReadablePrinter) PrintObj(obj runtime.Object, output io.Writer) error

PrintObj prints the obj in a human-friendly format according to the type of the obj.

type PrintHandler

type PrintHandler interface {
	TableHandler(columns []metav1beta1.TableColumnDefinition, printFunc interface{}) error
}

PrintHandler - interface to handle printing provided an array of metav1beta1.TableColumnDefinition

type PrintOptions

type PrintOptions struct {
	NoHeaders     bool
	WithNamespace bool
	WithKind      bool
	Wide          bool
	ShowLabels    bool
	Kind          schema.GroupKind
	ColumnLabels  []string

	SortBy string

	// indicates if it is OK to ignore missing keys for rendering an output template.
	AllowMissingKeys bool
}

PrintOptions struct defines a struct for various print options

type ResourcePrinter

type ResourcePrinter interface {
	// Print receives a runtime object, formats it and prints it to a writer.
	PrintObj(runtime.Object, io.Writer) error
}

ResourcePrinter is an interface that knows how to print runtime objects.

func NewTablePrinter

func NewTablePrinter(options PrintOptions) ResourcePrinter

NewTablePrinter creates a printer suitable for calling PrintObj().

type ResourcePrinterFunc

type ResourcePrinterFunc func(runtime.Object, io.Writer) error

ResourcePrinterFunc is a function that can print objects

func (ResourcePrinterFunc) PrintObj

func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj implements ResourcePrinter

type TableGenerator

type TableGenerator interface {
	GenerateTable(obj runtime.Object, options GenerateOptions) (*metav1beta1.Table, error)
}

TableGenerator - an interface for generating metav1beta1.Table provided a runtime.Object