output

Documentation

Index

• Constants
• func Err(format string, args ...any)
• type Format
  • func ParseFormat(s string) (Format, error)
• type Writer
  • func New(format Format) *Writer
  • func (w *Writer) Format() Format
  • func (w *Writer) JSON(v any) error
  • func (w *Writer) Print(msg string)
  • func (w *Writer) Printf(format string, args ...any)
  • func (w *Writer) Table(headers []string, rows [][]string)

Constants

const FormatFlag = "output format: table, json"

FormatFlag is the standard --output / -o flag description.

Functions

func Err

func Err(format string, args ...any)

Err writes to stderr.

Types

type Format

type Format string

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

func ParseFormat

func ParseFormat(s string) (Format, error)

ParseFormat validates and converts a format string.

type Writer

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

Writer wraps an io.Writer with output format control.

func New

func New(format Format) *Writer

func (*Writer) Format

func (w *Writer) Format() Format

func (*Writer) JSON

func (w *Writer) JSON(v any) error

JSON pretty-prints v as JSON.

func (*Writer) Print

func (w *Writer) Print(msg string)

Print writes a plain line.

func (*Writer) Printf

func (w *Writer) Printf(format string, args ...any)

Printf writes a formatted line.

func (*Writer) Table

func (w *Writer) Table(headers []string, rows [][]string)

Table writes rows in a tab-aligned table. headers is the header row.