| commit | 6d954f502eb89cd315e4baae5b0e0db516d6f787 | [log] [tgz] |
|---|---|---|
| author | Sherlock Holo <sherlockya@gmail.com> | Fri Jan 03 19:25:31 2020 +0800 |
| committer | Adrian Perez <perezg.adrian@gmail.com> | Fri Jan 03 12:25:31 2020 +0100 |
| tree | c69b9dc20f83fce972f204e8e959c552cae45306 | |
| parent | 7f95ac13edff643b8ce5398b6ccab125f8a20c1a [diff] |
feat: support std errors functions (#213) * feat: support std errors functions add function `Is`, `As` and `Unwrap`, like std errors, so that we can continue to use pkg/errors with go1.13 compatibility Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * style: delete useless comments Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * build: update makefile update makefile to download dependencies before test anything Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * build: fix makefile Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * chore: delete useless comments Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * Restore Makefile * revert: revert some change some change are doing by PR #206 and #212 , so I don't need to do it Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * test: add more check for As unit test Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * revert: only support Is As Unwrap for >=go1.13 Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * feat(Unwrap): allow <go1.13 can use Unwrap `Unwrap` just use type assert, it doesn't need go1.13 actually Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * test: add go1.13 errors compatibility check Signed-off-by: Sherlock Holo <sherlockya@gmail.com> * refactor(Unwrap): don't allow <go1.13 use Unwrap If we implement Unwrap ourselves, may create a risk of incompatibility if Go 1.14 subtly changes its `Unwrap` implementation. <go1.13 users doesn't have `Is` or `As`, if they want, they will use xerrors and it also provides `Unwrap` Signed-off-by: Sherlock Holo <sherlockya@gmail.com>
Package errors provides simple error handling primitives.
go get github.com/pkg/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.
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")
}
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.
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:
switch err := errors.Cause(err).(type) { case *MyError: // handle specifically default: // unknown error }
Read the package documentation for more information.
With the upcoming Go2 error proposals this package is moving into maintenance mode. The roadmap for a 1.0 release is as follows:
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.
BSD-2-Clause