diff options
author | Michael Muré <batolettre@gmail.com> | 2019-11-03 20:47:29 +0100 |
---|---|---|
committer | Michael Muré <batolettre@gmail.com> | 2019-11-03 20:47:29 +0100 |
commit | cb8236c9c22007eb622b7219c58d3342f1f53d50 (patch) | |
tree | e232e5362486065d9b28bb55b9791690efb50c08 /vendor/github.com/go-errors/errors/README.md | |
parent | 163ea9c93306c387f84ff0b85c2d8fca4c01e449 (diff) | |
download | git-bug-cb8236c9c22007eb622b7219c58d3342f1f53d50.tar.gz |
termui: migrate to awesome-gocui instead of the old fork I had
Diffstat (limited to 'vendor/github.com/go-errors/errors/README.md')
-rw-r--r-- | vendor/github.com/go-errors/errors/README.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/vendor/github.com/go-errors/errors/README.md b/vendor/github.com/go-errors/errors/README.md new file mode 100644 index 00000000..5d4f1873 --- /dev/null +++ b/vendor/github.com/go-errors/errors/README.md @@ -0,0 +1,66 @@ +go-errors/errors +================ + +[![Build Status](https://travis-ci.org/go-errors/errors.svg?branch=master)](https://travis-ci.org/go-errors/errors) + +Package errors adds stacktrace support to errors in go. + +This is particularly useful when you want to understand the state of execution +when an error was returned unexpectedly. + +It provides the type \*Error which implements the standard golang error +interface, so you can use this library interchangably with code that is +expecting a normal error return. + +Usage +----- + +Full documentation is available on +[godoc](https://godoc.org/github.com/go-errors/errors), but here's a simple +example: + +```go +package crashy + +import "github.com/go-errors/errors" + +var Crashed = errors.Errorf("oh dear") + +func Crash() error { + return errors.New(Crashed) +} +``` + +This can be called as follows: + +```go +package main + +import ( + "crashy" + "fmt" + "github.com/go-errors/errors" +) + +func main() { + err := crashy.Crash() + if err != nil { + if errors.Is(err, crashy.Crashed) { + fmt.Println(err.(*errors.Error).ErrorStack()) + } else { + panic(err) + } + } +} +``` + +Meta-fu +------- + +This package was original written to allow reporting to +[Bugsnag](https://bugsnag.com/) from +[bugsnag-go](https://github.com/bugsnag/bugsnag-go), but after I found similar +packages by Facebook and Dropbox, it was moved to one canonical location so +everyone can benefit. + +This package is licensed under the MIT license, see LICENSE.MIT for details. |