util

Documentation

Index

• Constants
• Variables
• func AllDone(t time.Duration)
• func BeforeTask(msg string)
• func CheckErr(err error)
• func IgnoreNotFoundErr(err error) error
• func IsToTable(printer *Printer) bool
• func PrintInventory(inventory map[string]string)
• func PrintOpenFunction()
• func TaskFail(msg string) string
• func ToTable(tableRow TableRow, objs ...runtime.Object) (*metav1.Table, error)
• func TranslateTimestampSince(timestamp metav1.Time) string
• func UsageErrorf(cmd *cobra.Command, format string, args ...interface{}) error
• type MessageLevel
• type Printer
  • func NewPrinter(operation string, scheme *runtime.Scheme) *Printer
  • func (p *Printer) AddFlags(cmd *cobra.Command)
  • func (p *Printer) SetForceDefail()
  • func (p *Printer) SetPrinterFunc(fc PrinterFunc)
  • func (p *Printer) ShouldPrintObject() bool
  • func (p *Printer) ToPrinter() (printers.ResourcePrinter, error)
  • func (p *Printer) ToPrinterWitchColumn(columnLabels []string) (printers.ResourcePrinter, error)
• type PrinterFunc
  • func WithDefaultPrinter(operation string) PrinterFunc
  • func WithTablePrinter(options printers.PrintOptions) PrinterFunc
• type TableRow

Constants

const (
	NormalMsg  = "normal"
	SuccessMsg = "success"
	ErrorMsg   = "error"
)

Variables

var (
	Yellow       = color.New(color.FgHiYellow, color.Bold).SprintFunc()
	YellowItalic = color.New(color.FgHiYellow, color.Bold, color.Italic).SprintFunc()
	Green        = color.New(color.FgHiGreen, color.Bold).SprintFunc()
	Blue         = color.New(color.FgHiBlue, color.Bold).SprintFunc()
	Cyan         = color.New(color.FgCyan, color.Bold, color.Underline).SprintFunc()
	Red          = color.New(color.FgHiRed, color.Bold).SprintFunc()
	White        = color.New(color.FgWhite).SprintFunc()
	WhiteBold    = color.New(color.FgWhite, color.Bold).SprintFunc()
)

Functions

func AllDone

func AllDone(t time.Duration)

func BeforeTask

func BeforeTask(msg string)

func CheckErr

func CheckErr(err error)

CheckErr prints a user friendly error to STDERR

func IgnoreNotFoundErr

func IgnoreNotFoundErr(err error) error

func IsToTable

func IsToTable(printer *Printer) bool

IsToTable if printer output format want prilnt object detail,return false

func PrintInventory

func PrintInventory(inventory map[string]string)

func PrintOpenFunction

func PrintOpenFunction()

func TaskFail

func TaskFail(msg string) string

func ToTable

func ToTable(tableRow TableRow, objs ...runtime.Object) (*metav1.Table, error)

ToTable runtime.Object convert metav1.Table to facilitate printing

func TranslateTimestampSince

func TranslateTimestampSince(timestamp metav1.Time) string

func UsageErrorf

func UsageErrorf(cmd *cobra.Command, format string, args ...interface{}) error

Types

type MessageLevel

type MessageLevel string

type Printer

type Printer struct {
	PrintFlags  *genericclioptions.PrintFlags
	PrinterFunc PrinterFunc

	ForceDetail bool
}

func NewPrinter

func NewPrinter(operation string, scheme *runtime.Scheme) *Printer

func (*Printer) AddFlags

func (p *Printer) AddFlags(cmd *cobra.Command)

func (*Printer) SetForceDefail

func (p *Printer) SetForceDefail()

func (*Printer) SetPrinterFunc

func (p *Printer) SetPrinterFunc(fc PrinterFunc)

func (*Printer) ShouldPrintObject

func (p *Printer) ShouldPrintObject() bool

func (*Printer) ToPrinter

func (p *Printer) ToPrinter() (printers.ResourcePrinter, error)

func (*Printer) ToPrinterWitchColumn

func (p *Printer) ToPrinterWitchColumn(columnLabels []string) (printers.ResourcePrinter, error)

type PrinterFunc

type PrinterFunc func(*Printer) (printers.ResourcePrinter, error)

func WithDefaultPrinter

func WithDefaultPrinter(operation string) PrinterFunc

func WithTablePrinter

func WithTablePrinter(options printers.PrintOptions) PrinterFunc

type TableRow

type TableRow func(obj interface{}) (metav1.TableRow, error)