trackable 0.1.3

This library provides a way to track objects manually as an alternative to mechanisms like backtracing
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

trackable
=========

[![Crates.io: trackable](http://meritbadge.herokuapp.com/trackable)](https://crates.io/crates/trackable)
[![Build Status](https://travis-ci.org/sile/trackable.svg?branch=master)](https://travis-ci.org/sile/trackable)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

`trackable` provides functionalities to define trackable objects and track those.

[Documentation](https://docs.rs/trackable)

Below code is an example that tracks failure of an I/O operation:

```rust
#[macro_use]
extern crate trackable;

use trackable::error::{Failed, Failure, ErrorKindExt};

fn foo() -> Result<(), Failure> {
    track_try!(std::fs::File::open("/path/to/non_existent_file")
               .map_err(|e| Failed.cause(e)));
    Ok(())
}
fn bar() -> Result<(), Failure> {
    track_try!(foo());
    Ok(())
}
fn baz() -> Result<(), Failure> {
    track_try!(bar());
    Ok(())
}

fn main() {
    let result = baz();
    assert!(result.is_err());

    let error = result.err().unwrap();
    assert_eq!(format!("\r{}", error), r#"
Failed (cause; No such file or directory)
HISTORY:
  [0] at rust_out:<anon>:7
  [1] at rust_out:<anon>:12
  [2] at rust_out:<anon>:16
"#);
}
```

This example used the built-in `Failure` type, but you can easily define your own trackable error types.
See the documentaion of [error](https://docs.rs/trackable/0.1/trackable/error/index.html) module for more details.


Installation
------------

Add following lines to your `Cargo.toml`:

```toml
[dependencies]
trackable = "0.1"
```