microerror

README

microerror

Go library to facilitate error handling.

Documentation

Index

• func Cause(err error) error
• func JSON(err error) string
• func Mask(err error) error
• func Maskf(err *Error, f string, v ...interface{}) error
• func Pretty(err error, stackTrace bool) string
• type Error
  • func (e *Error) Error() string
  • func (e *Error) GoString() string
• type JSONError
• type StackEntry

Functions

func Cause

func Cause(err error) error

Cause is here only for backward compatibility purposes and should not be used.

NOTE: Use errors.Is/errors.As instead.

func JSON

func JSON(err error) string

JSON prints the error with enriched information in JSON format. Enriched information includes:

• All fields from Error type.
• Error stack.

The rendered JSON can be unmarshalled with JSONError type.

func Mask

func Mask(err error) error

func Maskf

func Maskf(err *Error, f string, v ...interface{}) error

func Pretty

func Pretty(err error, stackTrace bool) string

Types

type Error

type Error struct {
	Desc string `json:"desc,omitempty"`
	Docs string `json:"docs,omitempty"`
	Kind string `json:"kind"`
}

func (*Error) Error

func (e *Error) Error() string

func (*Error) GoString

func (e *Error) GoString() string

GoString is here for backward compatibility.

NOTE: Use JSON(err) instead of Printf("%#v", err).

type JSONError

type JSONError struct {
	*Error `json:",inline"`

	Annotation string       `json:"annotation,omitempty"`
	Stack      []StackEntry `json:"stack,omitempty"`
}

type StackEntry

type StackEntry struct {
	File string  `json:"file"`
	Line int     `json:"line"`
	PC   uintptr `json:"-"`
}