errors version 0.2.0
Merge pull request #7 from umairidris/wrapf

Add Wrapf
tree: 4578f34c04270d0cb7deaacf7b54a8cc2d658d15
  1. .gitignore
  2. .travis.yml
  5. errors.go
  6. errors_test.go
  7. example_test.go

errors Travis-CI GoDoc Report card

Package errors implements functions for manipulating errors.

The traditional error handling idiom in Go is roughly akin to

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

_, err := ioutil.ReadAll(r)
if err != nil {
        return errors.Wrap(err, "read failed")

In addition, errors.Wrap records the file and line where it was called, allowing the programmer to retrieve the path to the original error.

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 recurse the operation of errors.Wrap to retrieve the original error for inspection. Any error value which implements this interface

type causer interface {
     Cause() error

Can be inspected by errors.Cause which will recursively retrieve the topmost error which does nor implement causer, which is assumed to be the original cause. For example:

switch err := errors.Cause(err).(type) {
case *MyError:
        // handle specifically
        // unknown error

Would you like to know more? Read the original presentation, blog post coming soon.


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.