This repository was archived by the owner on Jan 9, 2026. It is now read-only.
forked from pkg/errors
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample_test.go
More file actions
251 lines (215 loc) · 6.78 KB
/
example_test.go
File metadata and controls
251 lines (215 loc) · 6.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
package errors_test
import (
"fmt"
"io"
"github.com/go-extras/errors"
)
func ExampleNew() {
err := errors.New("whoops")
fmt.Println(err)
// Output: whoops
}
func ExampleNew_printf() {
err := errors.New("whoops")
fmt.Printf("%+v", err)
// Example output:
// whoops
// github.com/go-extras/errors_test.ExampleNew_printf
// /home/dfc/src/github.com/go-extras/errors/example_test.go:17
// testing.runExample
// /home/dfc/go/src/testing/example.go:114
// testing.RunExamples
// /home/dfc/go/src/testing/example.go:38
// testing.(*M).Run
// /home/dfc/go/src/testing/testing.go:744
// main.main
// /github.com/go-extras/errors/_test/_testmain.go:106
// runtime.main
// /home/dfc/go/src/runtime/proc.go:183
// runtime.goexit
// /home/dfc/go/src/runtime/asm_amd64.s:2059
}
func ExampleWithMessage() {
cause := errors.New("whoops")
err := errors.WithMessage(cause, "oh noes")
fmt.Println(err)
// Output: oh noes: whoops
}
func ExampleWithStack() {
cause := errors.New("whoops")
err := errors.WithStack(cause)
fmt.Println(err)
// Output: whoops
}
func ExampleWithStack_printf() {
cause := errors.New("whoops")
err := errors.WithStack(cause)
fmt.Printf("%+v", err)
// Example Output:
// whoops
// github.com/go-extras/errors_test.ExampleWithStack_printf
// /home/fabstu/go/src/github.com/go-extras/errors/example_test.go:55
// testing.runExample
// /usr/lib/go/src/testing/example.go:114
// testing.RunExamples
// /usr/lib/go/src/testing/example.go:38
// testing.(*M).Run
// /usr/lib/go/src/testing/testing.go:744
// main.main
// github.com/go-extras/errors/_test/_testmain.go:106
// runtime.main
// /usr/lib/go/src/runtime/proc.go:183
// runtime.goexit
// /usr/lib/go/src/runtime/asm_amd64.s:2086
// github.com/go-extras/errors_test.ExampleWithStack_printf
// /home/fabstu/go/src/github.com/go-extras/errors/example_test.go:56
// testing.runExample
// /usr/lib/go/src/testing/example.go:114
// testing.RunExamples
// /usr/lib/go/src/testing/example.go:38
// testing.(*M).Run
// /usr/lib/go/src/testing/testing.go:744
// main.main
// github.com/go-extras/errors/_test/_testmain.go:106
// runtime.main
// /usr/lib/go/src/runtime/proc.go:183
// runtime.goexit
// /usr/lib/go/src/runtime/asm_amd64.s:2086
}
func ExampleWrap() {
cause := errors.New("whoops")
err := errors.Wrap(cause, "oh noes")
fmt.Println(err)
// Output: oh noes: whoops
}
func fn() error {
e1 := errors.New("error")
e2 := errors.Wrap(e1, "inner")
e3 := errors.Wrap(e2, "middle")
return errors.Wrap(e3, "outer")
}
func ExampleCause() {
err := fn()
fmt.Println(err)
fmt.Println(errors.Cause(err))
// Output: outer: middle: inner: error
// error
}
func ExampleWrap_extended() {
err := fn()
fmt.Printf("%+v\n", err)
// Example output:
// error
// github.com/go-extras/errors_test.fn
// /home/dfc/src/github.com/go-extras/errors/example_test.go:47
// github.com/go-extras/errors_test.ExampleCause_printf
// /home/dfc/src/github.com/go-extras/errors/example_test.go:63
// testing.runExample
// /home/dfc/go/src/testing/example.go:114
// testing.RunExamples
// /home/dfc/go/src/testing/example.go:38
// testing.(*M).Run
// /home/dfc/go/src/testing/testing.go:744
// main.main
// /github.com/go-extras/errors/_test/_testmain.go:104
// runtime.main
// /home/dfc/go/src/runtime/proc.go:183
// runtime.goexit
// /home/dfc/go/src/runtime/asm_amd64.s:2059
// github.com/go-extras/errors_test.fn
// /home/dfc/src/github.com/go-extras/errors/example_test.go:48: inner
// github.com/go-extras/errors_test.fn
// /home/dfc/src/github.com/go-extras/errors/example_test.go:49: middle
// github.com/go-extras/errors_test.fn
// /home/dfc/src/github.com/go-extras/errors/example_test.go:50: outer
}
func ExampleWrapf() {
cause := errors.New("whoops")
err := errors.Wrapf(cause, "oh noes #%d", 2)
fmt.Println(err)
// Output: oh noes #2: whoops
}
func ExampleErrorf_extended() {
err := errors.Errorf("whoops: %s", "foo")
fmt.Printf("%+v", err)
// Example output:
// whoops: foo
// github.com/go-extras/errors_test.ExampleErrorf
// /home/dfc/src/github.com/go-extras/errors/example_test.go:101
// testing.runExample
// /home/dfc/go/src/testing/example.go:114
// testing.RunExamples
// /home/dfc/go/src/testing/example.go:38
// testing.(*M).Run
// /home/dfc/go/src/testing/testing.go:744
// main.main
// /github.com/go-extras/errors/_test/_testmain.go:102
// runtime.main
// /home/dfc/go/src/runtime/proc.go:183
// runtime.goexit
// /home/dfc/go/src/runtime/asm_amd64.s:2059
}
func Example_stackTrace() {
type stackTracer interface {
StackTrace() errors.StackTrace
}
err, ok := errors.Cause(fn()).(stackTracer)
if !ok {
panic("oops, err does not implement stackTracer")
}
st := err.StackTrace()
fmt.Printf("%+v", st[0:2]) // top two frames
// Example output:
// github.com/go-extras/errors_test.fn
// /home/dfc/src/github.com/go-extras/errors/example_test.go:47
// github.com/go-extras/errors_test.Example_stackTrace
// /home/dfc/src/github.com/go-extras/errors/example_test.go:127
}
func ExampleCause_printf() {
err := errors.Wrap(func() error {
return func() error {
return errors.New("hello world")
}()
}(), "failed")
fmt.Printf("%v", err)
// Output: failed: hello world
}
func ExampleWithFields() {
err := errors.New("whoops")
err = errors.WithFields(err, errors.Fields{"dummy": "yummy"})
fmt.Println(err)
fmt.Println(errors.ErrFields(err))
// Output:
// whoops
// map[dummy:yummy]
}
func ExampleWithFields_extended() {
err := errors.New("whoops")
err = errors.WithFields(err, errors.Fields{"dummy": "yummy"})
err = errors.WithMessage(err, "hello")
err = errors.WithFields(err, errors.Fields{"yummy": "dummy"})
fmt.Println("err:", err)
fmt.Println("fields:", errors.ErrFields(err))
fmt.Println("errors.Unwrap(err):", errors.Unwrap(err))
fmt.Println("errors.Cause(err):", errors.Cause(err))
// Output:
// err: hello: whoops
// fields: map[dummy:yummy yummy:dummy]
// errors.Unwrap(err): hello: whoops
// errors.Cause(err): whoops
}
func ExampleWithEquivalents() {
err := errors.New("whoops")
err = errors.WithEquivalents(err, io.ErrClosedPipe, io.EOF)
fmt.Println("err:", err)
fmt.Println("errors.Unwrap(err):", errors.Unwrap(err))
fmt.Println("errors.Cause(err):", errors.Cause(err))
fmt.Println("errors.Is(err, io.ErrClosedPipe):", errors.Is(err, io.ErrClosedPipe))
fmt.Println("errors.Is(err, io.EOF):", errors.Is(err, io.EOF))
// Output:
// err: whoops
// errors.Unwrap(err): whoops
// errors.Cause(err): whoops
// errors.Is(err, io.ErrClosedPipe): true
// errors.Is(err, io.EOF): true
}