human-panic 0.2.0

Panic messages for humans
Documentation 
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

# human-panic
[![crates.io version][1]][2] [![build status][3]][4]
[![downloads][5]][6] [![docs.rs docs][7]][8]

Panic messages for humans. Replacement for
[`std::panic::catch_unwind`](https://doc.rust-lang.org/std/panic/fn.catch_unwind.html)
to make errors nice for humans.

- [Documentation][8]
- [Crates.io][2]

## Why?
When you're building a CLI, polish is super important. Even though Rust is
pretty great at safety, it's not unheard of to access the wrong index in a
vector or have an assert fail somewhere.

When an error eventually occurs, you probably will want to know about it. So
instead of just providing an error message on the command line, we can create a
call to action for people to submit a report.

This should empower people to engage in communication, lowering the chances
people might get frustrated. And making it easier to figure out what might be
causing bugs.

### Default Output
```txt
thread 'main' panicked at 'oops', examples/main.rs:2:3
note: Run with `RUST_BACKTRACE=1` for a backtrace.
```

### Human-Panic Output
```txt
Well, this is embarrasing.

human-panic had a problem and crashed. To help us diagnose the problem you can
send us a crash report.

We have generated a report file at "<reports not generated yet>". Submit an
issue or email with the subject of "human-panic Crash Report" and include the
report as an attachment.

- Homepage: https://github.com/yoshuawuyts/human-panic
- Authors: Yoshua Wuyts <yoshuawuyts@gmail.com>

We take privacy seriously, and do not perform any automated error collection. In
order to improve the software, we rely on people to submit reports.

Thank you kindly!
```

## Usage
```rust
extern crate human_panic;

human_panic::catch_unwind(|| {
  panic!("something went wrong");
});
```

## Notes
Because we rely on `std::panic::catch_unwind`, we inherit some of the same
limitations. More specifically: [we can only catch unwinding panics, not
aborts](https://doc.rust-lang.org/std/panic/fn.catch_unwind.html#notes). This
should be alright for most cases, but it's good to be aware of what the
limitations are.

## Installation
```sh
$ cargo add human-panic
```

## License
[MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE)

[1]: https://img.shields.io/crates/v/human-panic.svg?style=flat-square
[2]: https://crates.io/crates/human-panic
[3]: https://img.shields.io/travis/yoshuawuyts/human-panic.svg?style=flat-square
[4]: https://travis-ci.org/yoshuawuyts/human-panic
[5]: https://img.shields.io/crates/d/human-panic.svg?style=flat-square
[6]: https://crates.io/crates/human-panic
[7]: https://docs.rs/human-panic/badge.svg
[8]: https://docs.rs/human-panic