microerror

package module

v0.4.1 Latest Latest Go to latest Published: Nov 9, 2023 License: Apache-2.0 Imports: 6 Imported by: 3,054

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/giantswarm/microerror

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 ¶ added in v0.2.0

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 ¶ added in v0.2.1

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 ¶ added in v0.2.0

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

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

type StackEntry ¶ added in v0.2.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL