Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pkg/errors
Simple error handling primitives
https://github.com/pkg/errors
Last synced: about 1 month ago
JSON representation
Simple error handling primitives
- Host: GitHub
- URL: https://github.com/pkg/errors
- Owner: pkg
- License: bsd-2-clause
- Archived: true
- Created: 2015-12-27T12:05:38.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-02T20:32:11.000Z (about 3 years ago)
- Last Synced: 2024-09-27T23:07:05.474Z (about 1 month ago)
- Language: Go
- Homepage: https://godoc.org/github.com/pkg/errors
- Size: 128 KB
- Stars: 8,181
- Watchers: 113
- Forks: 694
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome - pkg/errors - 11 star:8.2k fork:0.7k Simple error handling primitives (Go)
- awesome-ccamel - pkg/errors - Simple error handling primitives (Go)
- awesome-whatthefar - errors
- awesome-github-star - errors
- awesome-starts - pkg/errors - Simple error handling primitives (Go)
- go-awesome - Error
- awesome-go - errors - Simple error handling primitives - ★ 3634 (Miscellaneous)
- awesome-go-extra - ARCHIVED - 12-27T12:05:38Z|2021-11-02T20:32:11Z| (Error Handling / Advanced Console UIs)
- awesome-go-zh - errors
README
# errors [](https://travis-ci.org/pkg/errors) [](https://ci.appveyor.com/project/davecheney/errors/branch/master) [](http://godoc.org/github.com/pkg/errors) [](https://goreportcard.com/report/github.com/pkg/errors) [](https://sourcegraph.com/github.com/pkg/errors?badge)
Package errors provides simple error handling primitives.
`go get github.com/pkg/errors`
The traditional error handling idiom in Go is roughly akin to
```go
if err != 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.
## Adding context to an error
The errors.Wrap function returns a new error that adds context to the original error. For example
```go
_, err := ioutil.ReadAll(r)
if err != nil {
return errors.Wrap(err, "read failed")
}
```
## Retrieving the cause of an error
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`.
```go
type 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:
```go
switch err := errors.Cause(err).(type) {
case *MyError:
// handle specifically
default:
// unknown error
}
```
[Read the package documentation for more information](https://godoc.org/github.com/pkg/errors).
## Roadmap
With the upcoming [Go2 error proposals](https://go.googlesource.com/proposal/+/master/design/go2draft.md) this package is moving into maintenance mode. The roadmap for a 1.0 release is as follows:
- 0.9. Remove pre Go 1.9 and Go 1.10 support, address outstanding pull requests (if possible)
- 1.0. Final release.
## Contributing
Because of the Go2 errors changes, this package is not accepting proposals for new functionality. With that said, we welcome pull requests, bug fixes and issue reports.
Before sending a PR, please discuss your change by raising an issue.
## License
BSD-2-Clause