https://github.com/go-pogo/errors
Package errors contains additional functions, interfaces and structs for recording stack frames, applying basic formatting, working with goroutines, multiple errors and custom error types.
https://github.com/go-pogo/errors
error error-stack frame go golang multi-error stacktrace sync trace waitgroup
Last synced: 19 days ago
JSON representation
Package errors contains additional functions, interfaces and structs for recording stack frames, applying basic formatting, working with goroutines, multiple errors and custom error types.
- Host: GitHub
- URL: https://github.com/go-pogo/errors
- Owner: go-pogo
- License: bsd-3-clause
- Created: 2020-09-17T17:29:22.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-03-21T12:10:09.000Z (about 2 months ago)
- Last Synced: 2026-03-22T01:52:17.091Z (about 2 months ago)
- Topics: error, error-stack, frame, go, golang, multi-error, stacktrace, sync, trace, waitgroup
- Language: Go
- Homepage:
- Size: 492 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
errors
======
[![Latest release][latest-release-img]][latest-release-url]
[![Build status][build-status-img]][build-status-url]
[![Go Report Card][report-img]][report-url]
[![Documentation][doc-img]][doc-url]
[latest-release-img]: https://img.shields.io/github/release/go-pogo/errors.svg?label=latest
[latest-release-url]: https://github.com/go-pogo/errors/releases
[build-status-img]: https://github.com/go-pogo/errors/actions/workflows/test.yml/badge.svg
[build-status-url]: https://github.com/go-pogo/errors/actions/workflows/test.yml
[report-img]: https://goreportcard.com/badge/github.com/go-pogo/errors
[report-url]: https://goreportcard.com/report/github.com/go-pogo/errors
[doc-img]: https://godoc.org/github.com/go-pogo/errors?status.svg
[doc-url]: https://pkg.go.dev/github.com/go-pogo/errors
Package `errors` contains additional functions, interfaces and structs for
recording stack frames, applying basic formatting, working with goroutines,
multiple errors and custom error types.
It is inspired by package `golang.org/x/xerrors` and is designed to be a drop-in
replacement for it, as well as the standard library's `errors` package.
The `errors.New` and `errors.Errorf` functions create errors whose content is a
text message and whom can trace stack frames. `errors.Wrap` and `errors.Wrapf`
create errors by wrapping an existing error with a similar error like
`errors.New` and `errors.Errorf`.
```sh
go get github.com/go-pogo/errors
```
```go
import "github.com/go-pogo/errors"
```
## `Msg`
Instead of defining error messages as global variables, it is possible to define
them as constants using `errors.Msg`.
```go
const ErrSomethingWentWrong errors.Msg = "something went wrong"
```
## Formatting
Wrap an existing error with `errors.WithFormatter` to upgrade the error to
include basic formatting.
Formatting is done using `xerrors.FormatError` and thus the same verbs are
supported. Any error created with this package implements the `fmt.Formatter`
and `xerrors.Formatter` interfaces.
```go
fmt.Printf("%+v", errors.WithFormatter(err))
```
## Stack tracing
Every error can track stack trace information. Just wrap it with
`errors.WithStack` and a complete stack trace is captured.
```go
err = errors.WithStack(err)
```
An `errors.StackTrace` can be retrieved using `errors.GetStackTrace`.
Printing the error results in a trace similar to:
invalid character 'i' looking for beginning of value:
github.com/go-pogo/errors.ExampleWithStack
/path/to/errors/examples_trace_test.go:43
github.com/go-pogo/errors.ExampleWithStack.func1
/path/to/errors/examples_trace_test.go:40
## Disable stack tracing
Stack tracing comes with a performance cost. For production environments this
cost can be undesirable. To disable stack tracing, compile your Go program with
the "notrace" tag.
```sh
go build -tags=notrace
```
## Catching panics
A convenient function is available to catch panics and store them as an error.
```go
var err error
defer errors.CatchPanic(&err)
```
## Backwards compatibility
`Unwrap`, `Is` and `As` are backwards compatible with the standard library's
`errors` package and act the same.
## Documentation
Additional detailed documentation is available at [pkg.go.dev][doc-url]
## Created with
## License
Copyright © 2019-2026 [Roel Schut](https://roelschut.nl). All rights reserved.
This project is governed by a BSD-style license that can be found in the [LICENSE](LICENSE) file.