orfail 2.0.0

Error handling library for portable unrecoverable errors
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

orfail
======

[![orfail](https://img.shields.io/crates/v/orfail.svg)](https://crates.io/crates/orfail)
[![Documentation](https://docs.rs/orfail/badge.svg)](https://docs.rs/orfail)
[![Actions Status](https://github.com/sile/orfail/workflows/CI/badge.svg)](https://github.com/sile/orfail/actions)
![License](https://img.shields.io/crates/l/orfail)

An error handling library for portable unrecoverable errors.

This crate provides,

- `Failure` struct that represents an unrecoverable error with an error message and user-level backtrace
  - Constituted with simple types (`u32`, `String`, and `Vec` of those)
    - Portable across process and language boundaries
  - Doesn't implement `std::error::Error` trait
- `OrFail` trait
  - Backtrace location is appended to `Failure` each time when calling `OrFail::or_fail()`
  - `bool`, `Option<_>` and `Result<_, _>` implement `OrFail`

Examples
--------

```rust
use orfail::{OrFail, Result};

fn check_non_zero(n: isize) -> Result<()> {
    (n != 0).or_fail()?;
    Ok(())
}

fn safe_div(x: isize, y: isize) -> Result<isize> {
    check_non_zero(y).or_fail()?;
    Ok(x / y)
}

// OK
assert_eq!(safe_div(4, 2), Ok(2));

// NG
assert_eq!(safe_div(4, 0).err().map(|e| e.to_string()),
           Some(
r#"expected `true` but got `false`
  at src/lib.rs:8
  at src/lib.rs:13
"#.to_owned()));
```