developer_debug_tools 0.1.0

Tools for developer to debug their code
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

# developer_debug_tools ![License](https://img.shields.io/crates/l/developer_debug_tools) [![developer_debug_tools on crates.io](https://img.shields.io/crates/v/developer_debug_tools)](https://crates.io/crates/developer_debug_tools) [![developer_debug_tools on docs.rs](https://docs.rs/developer_debug_tools/badge.svg)](https://docs.rs/developer_debug_tools) [![Source Code Repository](https://img.shields.io/badge/Code-On%20GitLab-blue?logo=GitLab)](https://gitlab.com/coderodent/developer_debug_tools)

## developer_debug_tools

The crate aids developers to their code
e.g debug recurive function by printing the recursion tree of call

Annotate any recursive function with proc macro `print_recursion_tree`. Recursion tree is printed in the stdout
at the end of recursive call.
The pre condition is that all arguments and return type of the function must implement std::fmt::Debug trait

```rust
use developer_debug_tools::print_recursion_tree;
#[print_recursion_tree(print_recursion_counter, print_each_pass)]
fn fibonacci_recursive(n: u16) -> u16 {
   if n <= 1 {
       return n;
   } else {
       return fibonacci_recursive(n - 1) + fibonacci_recursive(n - 2);
   }
} 
```

Output of fibonacci_recursive(3) is as below

```text
fibonacci_recursive
 └─ 3
    ├─ 2
    │  ├─ 1
    │  │  └─ =1
    │  ├─ 0
    │  │  └─ =0
    │  └─ =1
    ├─ 1
    │  └─ =1
    └─ =2
```

`fibonacci_recursive` is the function name

`└─3`, `└─2` denotes argument passed to the function

`└─ =2`, `└─ =1` are the return value of each recursive call

Two flags(attributes) are supported by this proc-macro

### 1. print_each_pass

This prints the recursion tree on each recursive call. If this flag is not provided,
recursion tree is printed only once at the end of the recursion

### 2.print_recursion_counter

This prints the total recursion calls evaluated. This can be useful to check the
optimization of recursive call e.g using memoization

```text
Total Number Of Recursions: 4
```