├── .gitignore ├── .travis.yml ├── DCO ├── LICENSE ├── MAINTAINERS ├── Makefile ├── README.md ├── doc.go ├── error.go ├── error_test.go ├── example_test.go ├── matcher.go ├── matcher_test.go ├── stack.go └── stack_test.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | *.prof 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | go: 4 | - 1.8 5 | 6 | go_import_path: gopkg.in/src-d/go-errors.v1 7 | 8 | install: 9 | - go get -v -t ./... 10 | 11 | script: 12 | - make test 13 | 14 | after_success: 15 | - bash <(curl -s https://codecov.io/bash) 16 | -------------------------------------------------------------------------------- /DCO: -------------------------------------------------------------------------------- 1 | Developer Certificate of Origin 2 | Version 1.1 3 | 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 5 | 660 York Street, Suite 102, 6 | San Francisco, CA 94110 USA 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | 12 | Developer's Certificate of Origin 1.1 13 | 14 | By making a contribution to this project, I certify that: 15 | 16 | (a) The contribution was created in whole or in part by me and I 17 | have the right to submit it under the open source license 18 | indicated in the file; or 19 | 20 | (b) The contribution is based upon previous work that, to the best 21 | of my knowledge, is covered under an appropriate open source 22 | license and I have the right under that license to submit that 23 | work with modifications, whether created in whole or in part 24 | by me, under the same open source license (unless I am 25 | permitted to submit under a different license), as indicated 26 | in the file; or 27 | 28 | (c) The contribution was provided directly to me by some other 29 | person who certified (a), (b) or (c) and I have not modified 30 | it. 31 | 32 | (d) I understand and agree that this project and the contribution 33 | are public and that a record of the contribution (including all 34 | personal information I submit with it, including my sign-off) is 35 | maintained indefinitely and may be redistributed consistent with 36 | this project or the open source license(s) involved. 37 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2017 Sourced Technologies, S.L. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /MAINTAINERS: -------------------------------------------------------------------------------- 1 | Máximo Cuadros Ortiz (@mcuadros) 2 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | COVERAGE_REPORT := coverage.txt 2 | COVERAGE_PROFILE := profile.out 3 | COVERAGE_MODE := atomic 4 | 5 | test: 6 | @echo "mode: $(COVERAGE_MODE)" > $(COVERAGE_REPORT); \ 7 | for dir in `find . -name "*.go" | grep -o '.*/' | sort -u`; do \ 8 | go test $$dir -coverprofile=$(COVERAGE_PROFILE) -covermode=$(COVERAGE_MODE); \ 9 | if [ $$? != 0 ]; then \ 10 | exit 2; \ 11 | fi; \ 12 | if [ -f $(COVERAGE_PROFILE) ]; then \ 13 | tail -n +2 $(COVERAGE_PROFILE) >> $(COVERAGE_REPORT); \ 14 | rm $(COVERAGE_PROFILE); \ 15 | fi; \ 16 | done; -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-errors [![GoDoc](https://godoc.org/gopkg.in/src-d/go-errors.v1?status.svg)](https://godoc.org/gopkg.in/src-d/go-errors.v1) [![Build Status](https://travis-ci.org/src-d/go-errors.svg?branch=master)](https://travis-ci.org/src-d/go-errors) [![codecov](https://codecov.io/gh/src-d/go-errors/branch/master/graph/badge.svg)](https://codecov.io/gh/src-d/go-errors) [![codebeat badge](https://codebeat.co/badges/e0c5d481-6200-4112-9144-f750317421f0)](https://codebeat.co/projects/github-com-src-d-go-errors) 2 | 3 | Yet another `errors` package, implementing error handling primitives with error wrapping and error tracing. 4 | 5 | ## Installation 6 | 7 | The recommended way to install go-errors is: 8 | 9 | ``` 10 | go get -u gopkg.in/src-d/go-errors.v1 11 | ``` 12 | 13 | ## Examples 14 | 15 | The `Kind` type allows you to create new errors containing the stack trace and also check if an error is of a particular kind. 16 | 17 | ```go 18 | var ErrExample = errors.NewKind("example") 19 | 20 | err := ErrExample.New() 21 | if ErrExample.Is(err) { 22 | fmt.Printf("%+v\n", err) 23 | } 24 | 25 | // Example Output: 26 | // example 27 | // 28 | // gopkg.in/src-d/errors%2v0_test.ExampleError_Format 29 | // /home/mcuadros/workspace/go/src/gopkg.in/src-d/errors.v0/example_test.go:60 30 | // testing.runExample 31 | // /usr/lib/go/src/testing/example.go:114 32 | // testing.RunExamples 33 | // /usr/lib/go/src/testing/example.go:38 34 | // testing.(*M).Run 35 | // /usr/lib/go/src/testing/testing.go:744 36 | // main.main 37 | // github.com/pkg/errors/_test/_testmain.go:106 38 | // runtime.main 39 | // /usr/lib/go/src/runtime/proc.go:183 40 | // runtime.goexit 41 | // /usr/lib/go/src/runtime/asm_amd64.s:2086 42 | ``` 43 | 44 | 45 | ### Error with format 46 | 47 | ```go 48 | var ErrMaxLimitReached = errors.NewKind("max. limit reached: %d") 49 | 50 | err := ErrMaxLimitReached.New(42) 51 | if ErrMaxLimitReached.Is(err) { 52 | fmt.Println(err) 53 | } 54 | 55 | // Output: max. limit reached: 42 56 | ``` 57 | 58 | 59 | ### Error wrapping 60 | 61 | ```go 62 | var ErrNetworking = errors.NewKind("network error") 63 | 64 | err := ErrNetworking.Wrap(io.EOF) 65 | if ErrNetworking.Is(err) { 66 | fmt.Println(err) 67 | } 68 | 69 | // Output: network error: EOF 70 | ``` 71 | 72 | You can find these examples and many more in the [examples](example_test.go) file. 73 | 74 | 75 | ## License 76 | 77 | Apache License 2.0, see [LICENSE](LICENSE) 78 | -------------------------------------------------------------------------------- /doc.go: -------------------------------------------------------------------------------- 1 | // Yet another `errors` package, implementing errors handling primitives, 2 | // allowing error wrapping and error tracing. 3 | package errors // import "gopkg.in/src-d/go-errors.v1" 4 | -------------------------------------------------------------------------------- /error.go: -------------------------------------------------------------------------------- 1 | package errors 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | ) 7 | 8 | // Kind represents the kind of an error, from a Kind you can generate as many 9 | // Error instances as you want of this Kind 10 | type Kind struct { 11 | Message string 12 | } 13 | 14 | // NewKind returns a Kind with the given msg 15 | func NewKind(msg string) *Kind { 16 | return &Kind{Message: msg} 17 | } 18 | 19 | // New returns a new Error, values can be passed to it if the Kind was created 20 | // using printf format 21 | func (k *Kind) New(values ...interface{}) *Error { 22 | return &Error{ 23 | kind: k, 24 | message: fmt.Sprintf(k.Message, values...), 25 | stack: NewStackTrace(1), 26 | } 27 | } 28 | 29 | // Wrap creates a new Error of this Kind with the cause error, values can be 30 | // passed to it if the Kind was created using printf format. 31 | func (k *Kind) Wrap(cause error, values ...interface{}) *Error { 32 | return &Error{ 33 | kind: k, 34 | cause: cause, 35 | message: fmt.Sprintf(k.Message, values...) + ": %s", 36 | stack: NewStackTrace(1), 37 | } 38 | } 39 | 40 | // Is checks if the given error or any of its children are of this Kind 41 | func (k *Kind) Is(err error) bool { 42 | if err == nil { 43 | return false 44 | } 45 | 46 | e, ok := err.(*Error) 47 | if !ok { 48 | return false 49 | } 50 | 51 | if k == e.kind { 52 | return true 53 | } 54 | 55 | if e.cause == nil { 56 | return false 57 | } 58 | 59 | return k.Is(e.cause) 60 | } 61 | 62 | // Error represents an error of some Kind, implements the error interface 63 | type Error struct { 64 | kind *Kind 65 | cause error 66 | message string 67 | stack StackTrace 68 | } 69 | 70 | // Cause returns the underlying cause of the error 71 | func (err *Error) Cause() error { 72 | return err.cause 73 | } 74 | 75 | // Unwrap returns the underlying cause of the error. 76 | // It implements a new optional error interface introduced in Go 1.13. 77 | func (err *Error) Unwrap() error { 78 | return err.cause 79 | } 80 | 81 | func (err *Error) Error() string { 82 | if err.cause == nil { 83 | return err.message 84 | } 85 | 86 | return fmt.Sprintf(err.message, err.cause.Error()) 87 | } 88 | 89 | // StackTrace returns an stack trace of the error 90 | func (err *Error) StackTrace() StackTrace { 91 | return err.stack 92 | } 93 | 94 | // Format implements fmt.Formatter and can be formatted by the fmt package. The 95 | // following verbs are supported 96 | // 97 | // %s print the error. If the error has a Cause it will be 98 | // printed recursively 99 | // %v see %s 100 | // %+v extended format. Each Frame of the error's StackTrace will 101 | // be printed in detail. 102 | func (err *Error) Format(s fmt.State, verb rune) { 103 | switch verb { 104 | case 'v': 105 | if s.Flag('+') { 106 | io.WriteString(s, err.Error()+"\n") 107 | err.stack.Format(s, verb) 108 | return 109 | } 110 | 111 | fallthrough 112 | case 's': 113 | io.WriteString(s, err.Error()) 114 | case 'q': 115 | fmt.Fprintf(s, "%q", err.Error()) 116 | } 117 | } 118 | -------------------------------------------------------------------------------- /error_test.go: -------------------------------------------------------------------------------- 1 | package errors 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | "strings" 7 | "testing" 8 | 9 | "github.com/stretchr/testify/assert" 10 | ) 11 | 12 | func TestNew(t *testing.T) { 13 | k := NewKind("foo") 14 | assert.Equal(t, k.Message, "foo") 15 | } 16 | 17 | func TestKindNew(t *testing.T) { 18 | k := NewKind("foo") 19 | err := k.New() 20 | assert.Equal(t, err.Error(), "foo") 21 | assert.NotNil(t, err.StackTrace()) 22 | } 23 | 24 | func TestKindNewWithFormat(t *testing.T) { 25 | k := NewKind("foo %s") 26 | err := k.New("bar") 27 | assert.Equal(t, err.Error(), "foo bar") 28 | } 29 | 30 | func TestKindWrap(t *testing.T) { 31 | k := NewKind("foo") 32 | err := k.Wrap(io.EOF) 33 | assert.Equal(t, err.Error(), "foo: EOF") 34 | assert.Equal(t, err.Cause(), io.EOF) 35 | assert.NotNil(t, err.StackTrace()) 36 | } 37 | 38 | func TestKindWrapWithFormat(t *testing.T) { 39 | k := NewKind("foo %s") 40 | err := k.Wrap(io.EOF, "bar") 41 | assert.Equal(t, err.Error(), "foo bar: EOF") 42 | assert.Equal(t, err.Cause(), io.EOF) 43 | assert.NotNil(t, err.StackTrace()) 44 | } 45 | 46 | func TestKindIs(t *testing.T) { 47 | k := NewKind("foo") 48 | err := k.New("bar") 49 | assert.Equal(t, k.Is(err), true) 50 | assert.Equal(t, k.Is(io.EOF), false) 51 | assert.Equal(t, k.Is(nil), false) 52 | } 53 | 54 | func TestKindIsChildren(t *testing.T) { 55 | k := NewKind("foo") 56 | err := k.Wrap(io.EOF) 57 | assert.Equal(t, k.Is(err), true) 58 | } 59 | 60 | func TestError(t *testing.T) { 61 | err := NewKind("foo %s").New("bar") 62 | assert.Equal(t, err.Error(), "foo bar") 63 | } 64 | 65 | func TestErrorCause(t *testing.T) { 66 | err := NewKind("foo").Wrap(io.EOF) 67 | assert.Equal(t, err.Error(), "foo: EOF") 68 | } 69 | 70 | func TestFormat(t *testing.T) { 71 | err := NewKind("foo %s").New("bar") 72 | assert.Equal(t, fmt.Sprintf("%s", err), "foo bar") 73 | } 74 | 75 | func TestFormatQuoted(t *testing.T) { 76 | err := NewKind("foo %s").New("bar") 77 | assert.Equal(t, fmt.Sprintf("%q", err), `"foo bar"`) 78 | } 79 | 80 | func TestFormatExtendedVerbose(t *testing.T) { 81 | err := NewKind("foo %s").New("bar") 82 | 83 | lines := strings.Split(fmt.Sprintf("%+v", err), "\n") 84 | assert.Len(t, lines, 8) 85 | assert.Equal(t, lines[0], "foo bar") 86 | assert.Equal(t, lines[2], "gopkg.in/src-d/go-errors%2ev1.TestFormatExtendedVerbose") 87 | } 88 | -------------------------------------------------------------------------------- /example_test.go: -------------------------------------------------------------------------------- 1 | package errors_test 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | 7 | "gopkg.in/src-d/go-errors.v1" 8 | ) 9 | 10 | func ExampleKind_New() { 11 | var ErrExample = errors.NewKind("example") 12 | 13 | err := ErrExample.New() 14 | if ErrExample.Is(err) { 15 | fmt.Println(err) 16 | } 17 | 18 | // Output: example 19 | } 20 | 21 | func ExampleKind_New_pattern() { 22 | var ErrMaxLimitReached = errors.NewKind("max. limit reached: %d") 23 | 24 | err := ErrMaxLimitReached.New(42) 25 | if ErrMaxLimitReached.Is(err) { 26 | fmt.Println(err) 27 | } 28 | 29 | // Output: max. limit reached: 42 30 | } 31 | 32 | func ExampleKind_Wrap() { 33 | var ErrNetworking = errors.NewKind("network error") 34 | 35 | err := ErrNetworking.Wrap(io.EOF) 36 | if ErrNetworking.Is(err) { 37 | fmt.Println(err) 38 | } 39 | 40 | // Output: network error: EOF 41 | } 42 | 43 | func ExampleKind_Wrap_pattern() { 44 | var ErrFileRead = errors.NewKind("error reading %s") 45 | 46 | err := ErrFileRead.Wrap(io.ErrUnexpectedEOF, "/tmp/file") 47 | if ErrFileRead.Is(err) { 48 | fmt.Println(err) 49 | } 50 | 51 | // Output: error reading /tmp/file: unexpected EOF 52 | } 53 | 54 | func ExampleKind_Wrap_nested() { 55 | var ErrNetworking = errors.NewKind("network error") 56 | var ErrReading = errors.NewKind("reading error") 57 | 58 | err3 := io.EOF 59 | err2 := ErrReading.Wrap(err3) 60 | err1 := ErrNetworking.Wrap(err2) 61 | if ErrReading.Is(err1) { 62 | fmt.Println(err1) 63 | } 64 | 65 | // Output: network error: reading error: EOF 66 | } 67 | 68 | func ExampleError_printf() { 69 | var ErrExample = errors.NewKind("example with stack trace") 70 | 71 | err := ErrExample.New() 72 | fmt.Printf("%+v\n", err) 73 | 74 | // Example Output: 75 | // example with stack trace 76 | // 77 | // gopkg.in/src-d/errors%2v0_test.ExampleError_Format 78 | // /home/mcuadros/workspace/go/src/gopkg.in/src-d/errors.v1/example_test.go:60 79 | // testing.runExample 80 | // /usr/lib/go/src/testing/example.go:114 81 | // testing.RunExamples 82 | // /usr/lib/go/src/testing/example.go:38 83 | // testing.(*M).Run 84 | // /usr/lib/go/src/testing/testing.go:744 85 | // main.main 86 | // github.com/pkg/errors/_test/_testmain.go:106 87 | // runtime.main 88 | // /usr/lib/go/src/runtime/proc.go:183 89 | // runtime.goexit 90 | // /usr/lib/go/src/runtime/asm_amd64.s:2086 91 | 92 | } 93 | 94 | func ExampleAny() { 95 | var ErrNetworking = errors.NewKind("network error") 96 | var ErrReading = errors.NewKind("reading error") 97 | 98 | err := ErrNetworking.New() 99 | if errors.Any(err, ErrReading, ErrNetworking) { 100 | fmt.Println(err) 101 | } 102 | 103 | // Output: network error 104 | } 105 | -------------------------------------------------------------------------------- /matcher.go: -------------------------------------------------------------------------------- 1 | package errors 2 | 3 | // Matcher matches a given error 4 | type Matcher interface { 5 | // Is returns true if the err matches 6 | Is(err error) bool 7 | } 8 | 9 | // Is check if err matches all matchers 10 | func Is(err error, matchers ...Matcher) bool { 11 | if len(matchers) == 0 { 12 | return false 13 | } 14 | 15 | for _, m := range matchers { 16 | if !m.Is(err) { 17 | return false 18 | } 19 | } 20 | 21 | return true 22 | } 23 | 24 | // Any checks if err matches any matchers 25 | func Any(err error, matchers ...Matcher) bool { 26 | if len(matchers) == 0 { 27 | return false 28 | } 29 | 30 | for _, m := range matchers { 31 | if m.Is(err) { 32 | return true 33 | } 34 | } 35 | 36 | return false 37 | } 38 | -------------------------------------------------------------------------------- /matcher_test.go: -------------------------------------------------------------------------------- 1 | package errors 2 | 3 | import ( 4 | "io" 5 | "testing" 6 | 7 | "github.com/stretchr/testify/assert" 8 | ) 9 | 10 | func TestIs(t *testing.T) { 11 | k := NewKind("foo") 12 | err := k.New("bar") 13 | 14 | assert.Equal(t, Is(err, k), true) 15 | assert.Equal(t, Is(io.EOF, k), false) 16 | } 17 | 18 | func TestIsEmpty(t *testing.T) { 19 | assert.Equal(t, Is(nil), false) 20 | } 21 | 22 | func TestIsMultiple(t *testing.T) { 23 | k1 := NewKind("foo") 24 | err1 := k1.New("bar") 25 | 26 | k2 := NewKind("qux") 27 | err2 := k2.Wrap(err1) 28 | 29 | assert.Equal(t, Is(err2, k1, k2), true) 30 | } 31 | 32 | func TestAny(t *testing.T) { 33 | k1 := NewKind("foo") 34 | err := k1.New("bar") 35 | 36 | k2 := NewKind("qux") 37 | 38 | assert.Equal(t, Any(err, k1, k2), true) 39 | assert.Equal(t, Any(io.EOF, k1, k2), false) 40 | } 41 | 42 | func TestAnyEmpty(t *testing.T) { 43 | assert.Equal(t, Any(nil), false) 44 | } 45 | -------------------------------------------------------------------------------- /stack.go: -------------------------------------------------------------------------------- 1 | package errors 2 | 3 | import ( 4 | "runtime" 5 | 6 | "github.com/pkg/errors" 7 | ) 8 | 9 | // StackTrace is stack of Frames from innermost (newest) to outermost (oldest). 10 | type StackTrace struct { 11 | errors.StackTrace 12 | } 13 | 14 | // NewStackTrace returns a new StackTrace, skipping the given number of frames, 15 | // to avoid including the caller 16 | func NewStackTrace(skip int) StackTrace { 17 | const depth = 32 18 | 19 | var pcs [depth]uintptr 20 | n := runtime.Callers(2+skip, pcs[:]) 21 | 22 | f := make(errors.StackTrace, n) 23 | for i := 0; i < n; i++ { 24 | f[i] = errors.Frame(pcs[i]) 25 | } 26 | 27 | return StackTrace{f} 28 | } 29 | -------------------------------------------------------------------------------- /stack_test.go: -------------------------------------------------------------------------------- 1 | package errors 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | 7 | "strings" 8 | 9 | "github.com/stretchr/testify/assert" 10 | ) 11 | 12 | func TestCaller(t *testing.T) { 13 | s := NewStackTrace(0) 14 | assert.NotNil(t, s) 15 | 16 | o := fmt.Sprintf("%s", s) 17 | assert.Equal(t, strings.HasPrefix(o, "[stack_test.go testing.go"), true) 18 | } 19 | 20 | func TestCallerSkip(t *testing.T) { 21 | full := NewStackTrace(0) 22 | assert.NotNil(t, full) 23 | 24 | s := NewStackTrace(1) 25 | assert.Len(t, s.StackTrace, len(full.StackTrace)-1) 26 | } 27 | --------------------------------------------------------------------------------