output

Documentation

Index

• type Formatter
  • func New(format string) Formatter
• type JSONFormatter
  • func (f *JSONFormatter) Format(w io.Writer, v any) error
  • func (f *JSONFormatter) FormatError(w io.Writer, code string, message string, hint string) error
• type TextFormatter
  • func (f *TextFormatter) Format(w io.Writer, v any) error
  • func (f *TextFormatter) FormatError(w io.Writer, code string, message string, hint string) error

Types

type Formatter

type Formatter interface {
	// Format writes v to the output stream.
	Format(w io.Writer, v any) error
	// FormatError writes a structured error to the output stream.
	FormatError(w io.Writer, code string, message string, hint string) error
}

Formatter renders structured data to an output stream.

func New

func New(format string) Formatter

New returns a Formatter for the given format name ("json" or "text").

type JSONFormatter

type JSONFormatter struct{}

JSONFormatter outputs data as indented JSON.

func (*JSONFormatter) Format

func (f *JSONFormatter) Format(w io.Writer, v any) error

func (*JSONFormatter) FormatError

func (f *JSONFormatter) FormatError(w io.Writer, code string, message string, hint string) error

type TextFormatter

type TextFormatter struct{}

TextFormatter outputs data as human-readable text.

func (*TextFormatter) Format

func (f *TextFormatter) Format(w io.Writer, v any) error

func (*TextFormatter) FormatError

func (f *TextFormatter) FormatError(w io.Writer, code string, message string, hint string) error