-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
removed deprecated stuff; added a copy of github.com/pkg/errors in to…
… make it easier for adapters to include that package
- Loading branch information
Showing
12 changed files
with
1,825 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
Copyright (c) 2015, Dave Cheney <[email protected]> | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
* Redistributions of source code must retain the above copyright notice, this | ||
list of conditions and the following disclaimer. | ||
|
||
* Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# 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) [![Sourcegraph](https://sourcegraph.com/github.com/pkg/errors/-/badge.svg)](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). | ||
|
||
## Contributing | ||
|
||
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. | ||
|
||
## License | ||
|
||
BSD-2-Clause |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
version: build-{build}.{branch} | ||
|
||
clone_folder: C:\gopath\src\github.com\pkg\errors | ||
shallow_clone: true # for startup speed | ||
|
||
environment: | ||
GOPATH: C:\gopath | ||
|
||
platform: | ||
- x64 | ||
|
||
# http://www.appveyor.com/docs/installed-software | ||
install: | ||
# some helpful output for debugging builds | ||
- go version | ||
- go env | ||
# pre-installed MinGW at C:\MinGW is 32bit only | ||
# but MSYS2 at C:\msys64 has mingw64 | ||
- set PATH=C:\msys64\mingw64\bin;%PATH% | ||
- gcc --version | ||
- g++ --version | ||
|
||
build_script: | ||
- go install -v ./... | ||
|
||
test_script: | ||
- set PATH=C:\gopath\bin;%PATH% | ||
- go test -v ./... | ||
|
||
#artifacts: | ||
# - path: '%GOPATH%\bin\*.exe' | ||
deploy: off |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
// +build go1.7 | ||
|
||
package errors | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
stderrors "errors" | ||
) | ||
|
||
func noErrors(at, depth int) error { | ||
if at >= depth { | ||
return stderrors.New("no error") | ||
} | ||
return noErrors(at+1, depth) | ||
} | ||
|
||
func yesErrors(at, depth int) error { | ||
if at >= depth { | ||
return New("ye error") | ||
} | ||
return yesErrors(at+1, depth) | ||
} | ||
|
||
// GlobalE is an exported global to store the result of benchmark results, | ||
// preventing the compiler from optimising the benchmark functions away. | ||
var GlobalE error | ||
|
||
func BenchmarkErrors(b *testing.B) { | ||
type run struct { | ||
stack int | ||
std bool | ||
} | ||
runs := []run{ | ||
{10, false}, | ||
{10, true}, | ||
{100, false}, | ||
{100, true}, | ||
{1000, false}, | ||
{1000, true}, | ||
} | ||
for _, r := range runs { | ||
part := "pkg/errors" | ||
if r.std { | ||
part = "errors" | ||
} | ||
name := fmt.Sprintf("%s-stack-%d", part, r.stack) | ||
b.Run(name, func(b *testing.B) { | ||
var err error | ||
f := yesErrors | ||
if r.std { | ||
f = noErrors | ||
} | ||
b.ReportAllocs() | ||
for i := 0; i < b.N; i++ { | ||
err = f(0, r.stack) | ||
} | ||
b.StopTimer() | ||
GlobalE = err | ||
}) | ||
} | ||
} |
Oops, something went wrong.