summaryrefslogtreecommitdiffstats
path: root/third_party/rust/new_debug_unreachable/README.md
blob: b9c8b1e2c448e2dfdf35aab3b1842926bf48c41a (plain)
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
# new_debug_unreachable

> unreachable!() in debug, std::intrinsics::unreachable() in release.

This is a fork of [`debug_unreachable`](https://crates.io/crates/debug_unreachable).

## [Documentation](https://docs.rs/new_debug_unreachable)

## Usage

Use the crates.io repository; add this to your `Cargo.toml` along
with the rest of your dependencies:

```toml
[dependencies]
new_debug_unreachable = "1.0"
```

In your Rust code, the library name is still `debug_unreachable`:

```rust
use debug_unreachable::debug_unreachable;

fn main() {
    if 0 > 100 {
        // Can't happen!
        unsafe { debug_unreachable!() }
    } else {
        println!("Good, 0 <= 100.");
    }
}
```

## Author

[Jonathan Reem](https://medium.com/@jreem) is the original author of debug-unreachable.

[Matt Brubeck](https://limpet.net/mbrubeck/) is the maintainer of this fork.

## License

MIT