printer

Documentation

Overview

Package printer implements printing functionality for cli.

Index

• Constants
• Variables
• type PType
  • func (p *PType) Set(s string) error
  • func (p *PType) String() string
  • func (p *PType) Type() string
• type Printer
  • func New(printerType PType, writer io.Writer) (Printer, error)

Constants

const (
	// PrinterTypeTable is a table printer PType.
	PrinterTypeTable = PType("table")
	// PrinterTypeJSON is a json printer PType.
	PrinterTypeJSON = PType("json")
)

Variables

var (
	// ErrUnknowPrinterType is an error if a printer type isn't known.
	ErrUnknowPrinterType = errors.New("unknown printer type")
	// ErrTableRequired is an error if the object being printed
	// isn't a metav1.Table.
	ErrTableRequired = errors.New("metav1.Table is required")
)

Types

type PType

type PType string

PType is a type declaration for a printer type.

func (*PType) Set

func (p *PType) Set(s string) error

Set sets value for var.

func (*PType) String

func (p *PType) String() string

String type casts to string.

func (*PType) Type

func (p *PType) Type() string

Type returns type in string format.

type Printer

type Printer interface {
	// Print is a method to print an object.
	Print(in interface{}) error
}

Printer is an interface for a printer.

func New

func New(printerType PType, writer io.Writer) (Printer, error)

New creates a new printer.