printer

Documentation

Overview

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Copyright Contributors to the Open Cluster Management project

Index

• Constants
• func DefaultIterFunc(key string, value interface{}) error
• func DefaultSegmenter(path string, start int) (segment string, next int)
• func GetSpinnerKlusterletStatus(kl *operatorv1.Klusterlet) string
• func GetSpinnerPodStatus(pod *corev1.Pod) string
• func NewSpinner(suffix string, interval time.Duration) *spinner.Spinner
• func NewSpinnerWithStatus(suffix string, interval time.Duration, final string, statusFunc func() string) *spinner.Spinner
• func PrintComponentsCRD(printer PrefixWriter, crdClient clientset.Interface, ...) error
• func PrintComponentsDeploy(printer PrefixWriter, deployClient kubernetes.Interface, ...) error
• func PrintOperatorCRD(printer PrefixWriter, crdClient clientset.Interface, name string) error
• func WorkDetails(keyPrefix string, work *workapiv1.ManifestWork) map[string]any
• type IterFunc
• type PrefixWriter
  • func NewPrefixWriter(out io.Writer) PrefixWriter
• type PrinterOption
  • func NewPrinterOption(o printers.PrintOptions) *PrinterOption
  • func (p *PrinterOption) AddFlag(fs *pflag.FlagSet)
  • func (p *PrinterOption) Competele()
  • func (p *PrinterOption) Print(stream genericiooptions.IOStreams, obj runtime.Object) error
  • func (p *PrinterOption) Validate() error
  • func (p *PrinterOption) WithTableConverter(f func(runtime.Object) *metav1.Table) *PrinterOption
  • func (p *PrinterOption) WithTreeConverter(f func(runtime.Object, *TreePrinter) *TreePrinter) *PrinterOption
• type Segmenter
• type TreePrinter
  • func NewTreePrinter(name string) TreePrinter
  • func (t *TreePrinter) AddFileds(name string, mp *map[string]interface{})
  • func (t *TreePrinter) Print(outstream io.Writer) error
• type Trie
  • func NewTrie(sgmt Segmenter) *Trie
  • func (trie *Trie) Get(key string) interface{}
  • func (trie *Trie) Iter(it IterFunc) error
  • func (trie *Trie) Put(key string, value interface{}) bool
• type Trier

Constants

const (
	LEVEL_0 = iota
	LEVEL_1
	LEVEL_2
	LEVEL_3
	LEVEL_4
)

Each level has 2 spaces for PrefixWriter

Functions

func DefaultIterFunc

func DefaultIterFunc(key string, value interface{}) error

func DefaultSegmenter

func DefaultSegmenter(path string, start int) (segment string, next int)

func GetSpinnerKlusterletStatus

func GetSpinnerKlusterletStatus(kl *operatorv1.Klusterlet) string

func GetSpinnerPodStatus

func GetSpinnerPodStatus(pod *corev1.Pod) string

func NewSpinner

func NewSpinner(suffix string, interval time.Duration) *spinner.Spinner

func NewSpinnerWithStatus

func NewSpinnerWithStatus(suffix string, interval time.Duration, final string, statusFunc func() string) *spinner.Spinner

func PrintComponentsCRD

func PrintComponentsCRD(printer PrefixWriter, crdClient clientset.Interface, resource []operatorv1.RelatedResourceMeta) error

func PrintComponentsDeploy

func PrintComponentsDeploy(printer PrefixWriter, deployClient kubernetes.Interface, resource []operatorv1.RelatedResourceMeta, name string) error

func PrintOperatorCRD

func PrintOperatorCRD(printer PrefixWriter, crdClient clientset.Interface, name string) error

func WorkDetails

func WorkDetails(keyPrefix string, work *workapiv1.ManifestWork) map[string]any

Types

type IterFunc

type IterFunc func(key string, value interface{}) error

type PrefixWriter

type PrefixWriter interface {
	// Write writes text with the specified indentation level.
	Write(level int, format string, a ...interface{})
	// WriteLine writes an entire line with no indentation level.
	WriteLine(a ...interface{})
	// Flush forces indentation to be reset.
	Flush()
}

PrefixWriter can write text at various indentation levels.

func NewPrefixWriter

func NewPrefixWriter(out io.Writer) PrefixWriter

NewPrefixWriter creates a new PrefixWriter.

type PrinterOption

type PrinterOption struct {
	Options printers.PrintOptions
	Format  string
	// contains filtered or unexported fields
}

func NewPrinterOption

func NewPrinterOption(o printers.PrintOptions) *PrinterOption

func (*PrinterOption) AddFlag

func (p *PrinterOption) AddFlag(fs *pflag.FlagSet)

func (*PrinterOption) Competele

func (p *PrinterOption) Competele()

func (*PrinterOption) Print

func (p *PrinterOption) Print(stream genericiooptions.IOStreams, obj runtime.Object) error

func (*PrinterOption) Validate

func (p *PrinterOption) Validate() error

func (*PrinterOption) WithTableConverter

func (p *PrinterOption) WithTableConverter(f func(runtime.Object) *metav1.Table) *PrinterOption

func (*PrinterOption) WithTreeConverter

func (p *PrinterOption) WithTreeConverter(f func(runtime.Object, *TreePrinter) *TreePrinter) *PrinterOption

type Segmenter

type Segmenter func(key string, start int) (segment string, nextIndex int)

type TreePrinter

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

func NewTreePrinter

func NewTreePrinter(name string) TreePrinter

func (*TreePrinter) AddFileds

func (t *TreePrinter) AddFileds(name string, mp *map[string]interface{})

AddFileds add the fileds need to print to TreePrinter. @param name : the name of object to be print @param mp : key is a string represents level and path, value is the value will be printed.

func (*TreePrinter) Print

func (t *TreePrinter) Print(outstream io.Writer) error

type Trie

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

func NewTrie

func NewTrie(sgmt Segmenter) *Trie

func (*Trie) Get

func (trie *Trie) Get(key string) interface{}

func (*Trie) Iter

func (trie *Trie) Iter(it IterFunc) error

func (*Trie) Put

func (trie *Trie) Put(key string, value interface{}) bool

type Trier

type Trier interface {
	Get(key string) interface{}
	Put(key string, value interface{}) bool
	Iter(it IterFunc) error
}