output

Documentation

Index

• func Print(format Format, data any) error
• func PrintTo(w io.Writer, format Format, data any) error
• func ValidFormat(s string) bool
• func ValidFormats() []string
• type Format
  • func ParseFormat(s string) Format
• type NotTabularError
  • func (e NotTabularError) Error() string
• type Tabular

Functions

func Print

func Print(format Format, data any) error

Print outputs data in the specified format. For JSON/YAML, data is serialized directly. For table, data must implement Tabular; if it does not, an error is returned.

func PrintTo

func PrintTo(w io.Writer, format Format, data any) error

PrintTo writes data to w in the specified format. Table output requires Tabular.

func ValidFormat

func ValidFormat(s string) bool

ValidFormat reports whether s is a recognized output format name.

func ValidFormats

func ValidFormats() []string

ValidFormats returns the list of recognized output format names.

Types

type Format

type Format string

Format represents an output format.

const (
	FormatTable Format = "table"
	FormatJSON  Format = "json"
	FormatYAML  Format = "yaml"
)

func ParseFormat

func ParseFormat(s string) Format

ParseFormat parses a format string, defaulting to table.

type NotTabularError

type NotTabularError struct {
	Got any
}

NotTabularError is returned by Print when table format is requested but the data does not implement Tabular. Use errors.As to inspect the type.

func (NotTabularError) Error

func (e NotTabularError) Error() string

type Tabular

type Tabular interface {
	Headers() []string
	Rows() [][]any
}

Tabular is implemented by result types that know how to render themselves as a table. Print uses this when the format is table; the same value is serialized directly for JSON/YAML.