README
¶
Errors
Package errors provides simple error handling primitives.
go get github.com/confetti-framework/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.
Adding context to an 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")
}
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.Unwrap.
type causer interface {
Unwrap() error
}
errors.Unwrap will recursively retrieve the topmost error which does not implement causer, which is assumed to be
the original cause. For example:
switch err := errors.Unwrap(err).(type) {
case *MyError:
// handle specifically
default:
// unknown error
}
<<<<<<< HEAD
Read the package documentation for more information.
762b551bf121c3fb7483623472bf3090cafff8d7
Contributing
Before sending a PR, please discuss your change by raising an issue.
Documentation
¶
Overview ¶
Package errors provides simple error handling primitives.
The traditional error handling idiom in Go is roughly akin to
if err != nil {
return err
}
which when 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 by recording a stack trace at the point Wrap is called, together with the supplied message. For example
_, err := ioutil.ReadAll(r)
if err != nil {
return errors.Wrap(err, "read failed")
}
If additional control is required, the errors.WithStack and errors.WithMessage functions destructure errors.Wrap into its component operations: annotating an error with a stack trace and with a message, respectively.
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
type unwrapper interface {
Unwrap() error
}
can be inspected by errors.Unwrap. errors.Unwrap will recursively retrieve the topmost error that does not implement unwrapper, which is assumed to be the original cause. For example:
switch err := errors.Unwrap(err).(type) {
case *MyError:
// handle specifically
default:
// unknown error
}
Although the unwrapper interface is not exported by this package, it is considered a part of its stable public interface.
Formatted printing of errors ¶
All error values returned from this package implement fmt.Formatter and can be formatted by the fmt package. The following verbs are supported:
%s print the error. If the error has a Unwrap it will be
printed recursively.
%v see %s
%+v extended format. Each Frame of the error's StackTrace will
be printed in detail.
Retrieving the stack trace of an error or wrapper ¶
New, errorf, Wrap, and Wrap record a stack trace at the point they are invoked. This information can be retrieved with the following interface:
type StackTracer interface {
StackTrace() errors.StackTrace
}
The returned errors.StackTrace type is defined as
type StackTrace []Frame
The Frame type represents a call site in the stack trace. Frame supports the fmt.Formatter interface that can be used for printing information about the stack trace of this error. For example:
if err, ok := err.(StackTracer); ok {
for _, f := range err.StackTrace() {
fmt.Printf("%+s:%d\n", f, f)
}
}
Although the stackTracer interface is not exported by this package, it is considered a part of its stable public interface.
See the documentation for Frame.Format for more details.
Example (StackTrace) ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func fn() error {
e1 := errors.New("error")
e2 := errors.Wrap(e1, "inner")
e3 := errors.Wrap(e2, "middle")
return errors.Wrap(e3, "outer")
}
func main() {
err, ok := errors.Unwrap(fn()).(errors.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/confetti-framework/errors_test.fn
// /home/dfc/src/github.com/confetti-framework/errors/example_test.go:47
// github.com/confetti-framework/errors_test.Example_stackTrace
// /home/dfc/src/github.com/confetti-framework/errors/example_test.go:127
}
Output:
Index ¶
- func As(err error, target interface{}) bool
- func FindLevel(err error) (syslog.Level, bool)
- func FindStatus(err error) (int, bool)
- func Format(st fmt.State, verb rune, err error)
- func Is(err error, target error) bool
- func New(message string, args ...interface{}) *fundamental
- func Unwrap(err error) error
- func WithLevel(err error, level syslog.Level) *withLevel
- func WithMessage(err error, message string, args ...interface{}) *withMessage
- func WithStack(err error) error
- func WithStatus(err error, status int) *withStatus
- func Wrap(err error, message string, args ...interface{}) *withStack
- type Frame
- type StackTrace
- type StackTracer
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func As ¶ added in v0.9.0
As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error matches target if the error's concrete value is assignable to the value pointed to by target, or if the error has a method As(interface{}) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.
As will panic if target is not a non-nil pointer to either a type that implements error, or to any interface type. As returns false if err is nil.
func FindStatus ¶ added in v0.11.0
func Is ¶ added in v0.9.0
Is reports whether any error in err's chain matches any of the targets.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error is considered to match a target if it is equal to that target or if it implements a method Is(error) bool such that Is(target) returns true.
func New ¶
func New(message string, args ...interface{}) *fundamental
New returns an error with the supplied message and formats according to a format specifier and returns the string as a value that satisfies error. New also records the stack trace at the point it was called.
Example ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
err := errors.New("whoops")
fmt.Println(err)
}
Output: whoops
Example (Printf) ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
err := errors.New("whoops")
fmt.Printf("%+v", err)
// Example output:
// whoops
// github.com/confetti-framework/errors_test.ExampleNew_printf
// /home/dfc/src/github.com/confetti-framework/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/confetti-framework/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
}
Output:
func Unwrap ¶ added in v0.9.0
Unwrap returns the underlying cause of the error, if possible. An error value has a cause if it implements the following interface:
type unwrapper interface {
Unwrap() error
}
If the error does not implement Unwrap, the original error will be returned. If the error is nil, nil will be returned without further investigation.
Example ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func fn() error {
e1 := errors.New("error")
e2 := errors.Wrap(e1, "inner")
e3 := errors.Wrap(e2, "middle")
return errors.Wrap(e3, "outer")
}
func main() {
err := fn()
fmt.Println(err)
fmt.Println(errors.Unwrap(err))
}
Output: outer: middle: inner: error error
Example (Printf) ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
err := errors.Wrap(func() error {
return func() error {
return errors.New("hello world")
}()
}(), "failed")
fmt.Printf("%v", err)
}
Output: failed: hello world
func WithMessage ¶ added in v0.8.0
WithMessage annotates err with a new message.
Example ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
cause := errors.New("whoops")
err := errors.WithMessage(cause, "oh noes")
fmt.Println(err)
}
Output: oh noes: whoops
func WithStack ¶ added in v0.8.0
WithStack annotates err with a stack trace at the point WithStack was called. If err is nil, WithStack returns nil.
Example ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
cause := errors.New("whoops")
err := errors.WithStack(cause)
fmt.Println(err)
}
Output: whoops
Example (Printf) ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
cause := errors.New("whoops")
err := errors.WithStack(cause)
fmt.Printf("%+v", err)
// Example Output:
// whoops
// github.com/confetti-framework/errors_test.ExampleWithStack_printf
// /home/fabstu/go/src/github.com/confetti-framework/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/confetti-framework/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/confetti-framework/errors_test.ExampleWithStack_printf
// /home/fabstu/go/src/github.com/confetti-framework/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/confetti-framework/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
}
Output:
func WithStatus ¶ added in v0.11.0
func Wrap ¶
Wrap returns an error annotating err with a stack trace at the point Wrap is called, and the supplied message. If err is nil, Wrap returns nil.
Example ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func main() {
cause := errors.New("whoops")
err := errors.Wrap(cause, "oh noes")
fmt.Println(err)
}
Output: oh noes: whoops
Example (Extended) ¶
package main
import (
"fmt"
"github.com/confetti-framework/errors"
)
func fn() error {
e1 := errors.New("error")
e2 := errors.Wrap(e1, "inner")
e3 := errors.Wrap(e2, "middle")
return errors.Wrap(e3, "outer")
}
func main() {
err := fn()
fmt.Printf("%+v\n", err)
// Example output:
// error
// github.com/confetti-framework/errors_test.fn
// /home/dfc/src/github.com/confetti-framework/errors/example_test.go:47
// github.com/confetti-framework/errors_test.ExampleUnwrap_printf
// /home/dfc/src/github.com/confetti-framework/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/confetti-framework/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/confetti-framework/errors_test.fn
// /home/dfc/src/github.com/confetti-framework/errors/example_test.go:48: inner
// github.com/confetti-framework/errors_test.fn
// /home/dfc/src/github.com/confetti-framework/errors/example_test.go:49: middle
// github.com/confetti-framework/errors_test.fn
// /home/dfc/src/github.com/confetti-framework/errors/example_test.go:50: outer
}
Output:
Types ¶
type Frame ¶ added in v0.6.0
type Frame uintptr
Frame represents a program counter inside a stack frame. For historical reasons if Frame is interpreted as a uintptr its value represents the program counter + 1.
func (Frame) Format ¶ added in v0.6.0
Format formats the frame according to the fmt.Formatter interface.
%s source file %d source line %n function name %v equivalent to %s:%d
Format accepts flags that alter the printing of some verbs, as follows:
%+s function name and path of source file relative to the compile time
GOPATH separated by \n\t (<funcname>\n\t<path>)
%+v equivalent to %+s:%d
func (Frame) MarshalText ¶ added in v0.9.0
MarshalText formats a stacktrace Frame as a text string. The output is the same as that of fmt.Sprintf("%+v", f), but without newlines or tabs.
type StackTrace ¶ added in v0.7.0
type StackTrace []Frame
StackTrace is stack of Frames from innermost (newest) to outermost (oldest).
func FindStack ¶ added in v0.11.0
func FindStack(err error) (StackTrace, bool)
func (StackTrace) Format ¶ added in v0.7.0
func (st StackTrace) Format(s fmt.State, verb rune)
Format formats the stack of Frames according to the fmt.Formatter interface.
%s lists source files for each Frame in the stack %v lists the source file and line number for each Frame in the stack
Format accepts flags that alter the printing of some verbs, as follows:
%+v Prints filename, function, and line number for each Frame in the stack.
type StackTracer ¶ added in v0.11.0
type StackTracer interface {
StackTrace() StackTrace
}
Source Files