clioutputwriter

Documentation

Index

• Variables
• func PrintData(w io.Writer, data TabularData, format Format) error
• func SupportedOutputFormats() []string
• type Format
  • func DefaultOutputFormat() Format
• type TabularData
  • func FilterColumns(data TabularData, columns []string) TabularData

Variables

var (
	ErrUnsupportedFormat = fmt.Errorf("unsupported output format")
)

Functions

func PrintData

func PrintData(w io.Writer, data TabularData, format Format) error

PrintData is the main function to print data in the specified format.

func SupportedOutputFormats

func SupportedOutputFormats() []string

SupportedOutputFormats returns the list of supported output formats, for use in help text.

Types

type Format

type Format string

Format represents the output format.

const (
	FormatTable   Format = "table"
	FormatJSON    Format = "json"
	FormatCSV     Format = "csv"
	FormatNuShell Format = "nushell"
)

func DefaultOutputFormat

func DefaultOutputFormat() Format

DefaultOutputFormat returns the suggested output format

type TabularData

type TabularData struct {
	Headers []string        // Column headers
	Rows    [][]interface{} // Rows of data
}

TabularData represents the data to be printed in a structured format.

func FilterColumns

func FilterColumns(data TabularData, columns []string) TabularData

FilterColumns will filter out all columns not in the provided list.