logs

Documentation

Overview

Package logs for the display of errors.

Index

• Constants
• Variables
• func Fatal(err error)
• func FatalCmd(usage string, args ...string)
• func FatalExecute(err error, args ...string)
• func FatalFlag(cmd, flag string, err error)
• func FatalMark(mark string, err, wrap error)
• func FatalSave(err error)
• func FatalWrap(err, wrap error)
• func Hint(s string, err error) string
• func LastEntry() (s string, err error)
• func Name() string
• func Save(err error)
• func Sprint(err error) string
• func SprintCmd(cmd string, err error) string
• func SprintFlag(cmd, flag string, err error) string
• func SprintMark(mark string, err, wrap error) string
• func SprintWrap(err, wrap error) string

Examples

• Save
• Sprint

Constants

const OSErrCode = 1

const (
	Panic = false
)

Variables

var (
	// internal arguments.
	ErrEmpty    = errors.New("value is empty")
	ErrErrorNil = errors.New("error value cannot be nil")
	ErrNameNil  = errors.New("name value cannot be empty")
	ErrShort    = errors.New("word count is too short, less than 3")

	// generic errors.
	ErrEncode    = errors.New("text encoding not known or supported")
	ErrFmt       = errors.New("format is not known")
	ErrHighlight = errors.New("could not format or colorize the element")
	ErrMax       = errors.New("maximum attempts reached")
	ErrTabFlush  = errors.New("tab writer could not write or flush")
	ErrZipFile   = errors.New("could not create the zip archive")

	// logs package errors.
	ErrCmd        = errors.New("the command is invalid")
	ErrFlag       = errors.New("the flag does not work with this command")
	ErrFlagChoice = errors.New("choose a value from the following")
	ErrFlagNil    = errors.New("the flag with a value must be included with this command")
	ErrNotBool    = errors.New("the value must be either true or false")
	ErrNotInt     = errors.New("the value must be a number")
	ErrNotInts    = errors.New("the value must be a single or a list of numbers")
	ErrNotNil     = errors.New("the value cannot be empty")
	ErrSave       = errors.New("save to log file failure")

	// config file.
	ErrConfigName = errors.New("unknown configuration or setting name")
	ErrConfigNew  = errors.New("could not create a configuration file")
	ErrConfigOpen = errors.New("could not open the configuration file")
	ErrConfigRead = errors.New("could not parse or use the configuration file")

	// pipe/stdin.
	ErrPipeEmpty = errors.New("empty text stream from piped stdin (standard input)")
	ErrPipeRead  = errors.New("could not read text stream from piped stdin (standard input)")
	ErrPipeParse = errors.New("could not parse the text stream from piped stdin (standard input)")

	// named file.
	ErrFileName  = errors.New("file does not exist")
	ErrFileOpen  = errors.New("could not open the file")
	ErrFileSave  = errors.New("could not save the file")
	ErrFileSaveD = errors.New("could not save the file to the directory")

	// sample file.
	ErrSampleName = errors.New("sample filename does not exist")
	ErrSampleOpen = errors.New("could not open the sample text")
	ErrSampleHTML = errors.New("could not convert the sample text to a HTML document")

	// template file.
	ErrTmplName  = errors.New("the named template layout does not exist")
	ErrTmplIsDir = errors.New("the named template file is a directory")

	// temporary directory.
	ErrTmpRMD   = errors.New("could not cleanup the temporary directory")
	ErrTmpSaveD = errors.New("could not save file to the temporary directory")

	// temporary file.
	ErrTmpClose = errors.New("could not close the temporary file")
	ErrTmpOpen  = errors.New("could not open the temporary file")
	ErrTmpSave  = errors.New("could not save to the temporary file")
)

Functions

func Fatal

func Fatal(err error)

Fatal prints a formatted error and exits.

func FatalCmd

func FatalCmd(usage string, args ...string)

FatalCmd prints a problem highlighting the unsupported command.

func FatalExecute

func FatalExecute(err error, args ...string)

FatalExecute is the error handler for the root command flags and arguments.

func FatalFlag

func FatalFlag(cmd, flag string, err error)

FatalFlag prints a problem with the flag and exits.

func FatalMark

func FatalMark(mark string, err, wrap error)

FatalMark formats the errors, highlights the value and exits.

func FatalSave

func FatalSave(err error)

FatalSave saves the error to the logfile and exits.

func FatalWrap

func FatalWrap(err, wrap error)

FatalWrap formats the errors and exits.

func Hint

func Hint(s string, err error) string

Hint returns a formatted error with a usage suggestion or hint.

func LastEntry

func LastEntry() (s string, err error)

LastEntry returns the most recent saved entry in the error log file.

func Name

func Name() string

Name is the absolute path and filename of the error log file.

func Save

func Save(err error)

Save by appending the error to the logfile.

Example

t := fmt.Sprintf("%s", ErrLogTest)
Save(ErrLogTest)
last, _ := LastEntry()
i := len(last) - len(t) - 1
fmt.Print(last[i:])

Output:

log test

func Sprint

func Sprint(err error) string

Sprint formats and returns the error.

Example

fmt.Println(Sprint(ErrTest))
fmt.Println(status)

Output:

Problem:
error.
exit status 1

func SprintCmd

func SprintCmd(cmd string, err error) string

SprintCmd returns the command does not exist.

func SprintFlag

func SprintFlag(cmd, flag string, err error) string

SprintFlag returns a problem with the flag.

func SprintMark

func SprintMark(mark string, err, wrap error) string

SprintMark formats and returns the errors and highlights the marked string.

func SprintWrap

func SprintWrap(err, wrap error) string

SprintWrap returns the formatted errors.