Name: errors
Owner: pkg
Description: Simple error handling primitives
Created: 2015-12-27 12:05:38.0
Updated: 2018-01-15 23:10:29.0
Pushed: 2017-12-21 10:49:54.0
Homepage: https://godoc.org/github.com/pkg/errors
Size: 91
Language: Go
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Package errors provides simple error handling primitives.
go get github.com/pkg/errors
The traditional error handling idiom in Go is roughly akin to
rr != nil {
return err
which applied recursively up the call stack results in error reports without context or debugging information. The errors package allows programmers to add context to the failure path in their code in a way that does not destroy the original value of the error.
The errors.Wrap function returns a new error that adds context to the original error. For example
rr := ioutil.ReadAll(r)
rr != nil {
return errors.Wrap(err, "read failed")
Using errors.Wrap constructs a stack of errors, adding context to the preceding error. Depending on the nature of the error it may be necessary to reverse the operation of errors.Wrap to retrieve the original error for inspection. Any error value which implements this interface can be inspected by errors.Cause.
causer interface {
Cause() error
errors.Cause will recursively retrieve the topmost error which does not implement causer, which is assumed to be the original cause. For example:
ch err := errors.Cause(err).(type) {
*MyError:
// handle specifically
ult:
// unknown error
Read the package documentation for more information.
We welcome pull requests, bug fixes and issue reports. With that said, the bar for adding new symbols to this package is intentionally set high.
Before proposing a change, please discuss your change by raising an issue.
BSD-2-Clause