exit

Documentation

Overview

Package exit contains functions useful for exiting gracefully.

Index

• Constants
• func UsageT(format string, a ...out.V)
• func WithCodeT(code int, format string, a ...out.V)
• func WithError(msg string, err error)
• func WithLogEntries(msg string, err error, entries map[string][]string)
• func WithProblem(msg string, p *problem.Problem)

Constants

const (
	Failure     = 1  // Failure represents a general failure code
	Interrupted = 2  // Ctrl-C (SIGINT)
	BadUsage    = 64 // Usage represents an incorrect command line
	Data        = 65 // Data represents incorrect data supplied by the user
	NoInput     = 66 // NoInput represents that the input file did not exist or was not readable
	Unavailable = 69 // Unavailable represents when a service was unavailable
	Software    = 70 // Software represents an internal software error.
	IO          = 74 // IO represents an I/O error
	Config      = 78 // Config represents an unconfigured or misconfigured state
	Permissions = 77 // Permissions represents a permissions error

	// MaxLogEntries controls the number of log entries to show for each source
	MaxLogEntries = 3
)

Exit codes based on sysexits(3)

Functions

func UsageT

func UsageT(format string, a ...out.V)

UsageT outputs a templated usage error and exits with error code 64

func WithCodeT

func WithCodeT(code int, format string, a ...out.V)

WithCodeT outputs a templated fatal error message and exits with the supplied error code.

func WithError

func WithError(msg string, err error)

WithError outputs an error and exits.

func WithLogEntries

func WithLogEntries(msg string, err error, entries map[string][]string)

WithLogEntries outputs an error along with any important log entries, and exits.

func WithProblem

func WithProblem(msg string, p *problem.Problem)

WithProblem outputs info related to a known problem and exits.