vendor/github.com/pkg/errors/README.md

   1 # errors [![Travis-CI](https://travis-ci.org/pkg/errors.svg)](https://travis-ci.org/pkg/errors) [![AppVeyor](https://ci.appveyor.com/api/projects/status/b98mptawhudj53ep/branch/master?svg=true)](https://ci.appveyor.com/project/davecheney/errors/branch/master) [![GoDoc](https://godoc.org/github.com/pkg/errors?status.svg)](http://godoc.org/github.com/pkg/errors) [![Report card](https://goreportcard.com/badge/github.com/pkg/errors)](https://goreportcard.com/report/github.com/pkg/errors)
   2
   3 Package errors provides simple error handling primitives.
   4
   5 `go get github.com/pkg/errors`
   6
   7 The traditional error handling idiom in Go is roughly akin to
   8 ```go
   9 if err != nil {
  10         return err
  11 }
  12 ```
  13 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.
  14
  15 ## Adding context to an error
  16
  17 The errors.Wrap function returns a new error that adds context to the original error. For example
  18 ```go
  19 _, err := ioutil.ReadAll(r)
  20 if err != nil {
  21         return errors.Wrap(err, "read failed")
  22 }
  23 ```
  24 ## Retrieving the cause of an error
  25
  26 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`.
  27 ```go
  28 type causer interface {
  29         Cause() error
  30 }
  31 ```
  32 `errors.Cause` will recursively retrieve the topmost error which does not implement `causer`, which is assumed to be the original cause. For example:
  33 ```go
  34 switch err := errors.Cause(err).(type) {
  35 case *MyError:
  36         // handle specifically
  37 default:
  38         // unknown error
  39 }
  40 ```
  41
  42 [Read the package documentation for more information](https://godoc.org/github.com/pkg/errors).
  43
  44 ## Contributing
  45
  46 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.
  47
  48 Before proposing a change, please discuss your change by raising an issue.
  49
  50 ## Licence
  51
  52 BSD-2-Clause