output

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 1, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package output renders results and errors as text or JSON and defines exit codes.

Index

Constants

View Source 
const (
	ExitOK         = 0
	ExitUnexpected = 1
	ExitUsage      = 2
	ExitAuth       = 3
	ExitConflict   = 4
	ExitNotFound   = 5
	ExitForbidden  = 6
	ExitNetwork    = 7
)

Variables

This section is empty.

Functions

func WriteError 

func WriteError(w io.Writer, m Mode, e *Error) error

WriteError renders the error envelope.

func WriteFields 

func WriteFields(w io.Writer, fields []Field) error

WriteFields prints aligned "key: value" lines for text mode.

func WriteJSON 

func WriteJSON(w io.Writer, v any) error

WriteJSON writes v as indented JSON without HTML escaping.

Types

type Error 

type Error struct {
	Code     string `json:"code"`
	Source   string `json:"source,omitempty"`
	Stage    string `json:"stage,omitempty"`
	Cause    string `json:"cause,omitempty"`
	Recovery string `json:"recovery,omitempty"`
	Exit     int    `json:"-"`
}

Error is the stable error envelope. Cause must never contain secrets.

func AsError 

func AsError(err error) *Error

AsError returns err as *Error, wrapping unknown errors as "unexpected".

func (*Error) Error 

func (e *Error) Error() string

type Field 

type Field struct{ Key, Value string }

type Mode 

type Mode int
const (
	Text Mode = iota
	JSON
)

func DetectMode 

func DetectMode(flag string, isTTY bool) (Mode, error)

DetectMode picks the output mode: explicit flag wins, otherwise text on a TTY and JSON elsewhere.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.