You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
1.2 KiB
37 lines
1.2 KiB
3 years ago
|
# errors [](https://pkg.go.dev/github.com/go-faster/errors#section-documentation) [](https://codecov.io/gh/go-faster/errors)
|
||
|
|
|
||
|
|
Fork of [xerrors](https://pkg.go.dev/golang.org/x/xerrors) with explicit [Wrap](https://pkg.go.dev/github.com/go-faster/errors#Wrap) instead of `%w`.
|
||
|
|
|
||
|
|
> Clear is better than clever.
|
||
|
|
|
||
|
|
```
|
||
|
|
go get github.com/go-faster/errors
|
||
|
|
```
|
||
|
|
|
||
|
|
```go
|
||
|
|
if err != nil {
|
||
|
|
return errors.Wrap(err, "something went wrong")
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Why
|
||
|
|
* Using `Wrap` is the most explicit way to wrap errors
|
||
|
|
* Wrapping with `fmt.Errorf("foo: %w", err)` is implicit, redundant and error-prone
|
||
|
|
* Parsing `"foo: %w"` is implicit, redundant and slow
|
||
|
|
* The [pkg/errors](https://github.com/pkg/errors) and [xerrrors](https://pkg.go.dev/golang.org/x/xerrors) are not maintainted
|
||
|
|
* The [cockroachdb/errors](https://github.com/cockroachdb/errors) is too big
|
||
|
|
* The `errors` has no caller stack trace
|
||
|
|
|
||
|
|
## Don't need traces?
|
||
|
|
Call `errors.DisableTrace` or use build tag `noerrtrace`.
|
||
|
|
|
||
|
|
## Migration
|
||
|
|
```
|
||
|
|
go get github.com/go-faster/errors/cmd/gowrapper@latest
|
||
|
|
gowrapper ./...
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
BSD-3-Clause, same as Go sources
|