printer

package

v2.2.0 Latest Latest Go to latest Published: Feb 17, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Package printer contains the definition of the Printer interface and the implementation of all the available printers implementing it.

This section is empty.

This section is empty.

This section is empty.

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

DefaultPrinter defines the DefaultPrinter configuration.

func (p *DefaultPrinter) Print(w io.Writer, root *resource.Resource) error

Print implements the Printer interface by prints the resource tree in a human-readable format.

func (p *DefaultPrinter) PrintList(w io.Writer, roots *resource.ResourceList) error

PrintList implements the Printer interface by prints the resource tree of a list of resources in a human-readable format.

type DotPrinter struct{}

DotPrinter defines the DotPrinter configuration.

func (p *DotPrinter) Print(w io.Writer, root *resource.Resource) error

Print gets all the nodes and then return the graph as a dot format string to the Writer.

func (p *DotPrinter) PrintList(w io.Writer, roots *resource.ResourceList) error

PrintList gets all the nodes and then return the graph as a dot format string to the Writer.

type JSONPrinter struct{}

JSONPrinter is a printer that prints the resource graph as JSON.

func (p *JSONPrinter) Print(w io.Writer, root *resource.Resource) error

Print implements the Printer interface.

func (p *JSONPrinter) PrintList(w io.Writer, roots *resource.ResourceList) error

PrintList implements the Printer interface.

type Printer interface {
	Print(w io.Writer, r *resource.Resource) error
	PrintList(w io.Writer, r *resource.ResourceList) error
}

Printer implements the interface which is used by all printers in this package.

func New(typeStr string) (Printer, error)

New creates a new printer based on the specified type.

type Type string

Type represents the type of printer.

const (
	TypeDefault Type = "default"
	TypeWide    Type = "wide"
	TypeJSON    Type = "json"
	TypeDot     Type = "dot"
)

Implemented PrinterTypes.