xkcd_unreachable 0.1.1

A Rust macro xkcd_unreachable!() inspired by https://xkcd.com/2200/
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

[![](https://img.shields.io/crates/v/xkcd_unreachable)](https://crates.io/crates/xkcd_unreachable)
[![](https://docs.rs/xkcd_unreachable/badge.svg)](https://docs.rs/xkcd_unreachable)

# `xkcd_unreachable`

A Rust macro `xkcd_unreachable!()` inspired by [xkcd 2200](https://xkcd.com/2200/)

## Example
```rust
use xkcd_unreachable::xkcd_unreachable;

fn foo(x: Option<i32>) {
    match x {
        Some(n) if n >= 0 => println!("Some(Non-negative)"),
        Some(n) if n <  0 => println!("Some(Negative)"),
        Some(_)           => xkcd_unreachable!(),
        None              => println!("None")
    }
}
```

## Output if reached
```text
⚠ ERROR

If you're seeing this, the code is in what
I thought was an unreachable state.

I could give you advice for what to do.
But honestly, why should you trust me?
I clearly screwed this up. I'm writing a
message that should never appear, yet
I know it will probably appear someday.

On a deep level, I know I'm not
up to this task. I'm so sorry.

<https://xkcd.com/2200/>
```

For more information, see the [documentation](https://docs.rs/xkcd_unreachable/).

![xkcd 2200](https://imgs.xkcd.com/comics/unreachable_state.png)