twyg 0.1.1

A tiny logging setup for Rust applications
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

# twyg

[![][logo]][logo-large]

*A tiny logging setup for Rust applications*

I got used to logging my apps in Clojure with [Twig](https://github.com/clojusc/twig)
and in LFE with [Logjam](https://github.com/lfex/logjam), so here this is.

## Usage

I like to put my logging setup in YAML config files for my apps, but however
you prefer to do that, you'll need to eventually populate the
`twyg::LoggerOpts` struct:

```rust
let opts = twyg::LoggerOpts{
        colored: true,
        file: "".to_string(),
        level: "debug".to_string(),
        report_caller: true,
    };
```

Options:

* `colored`: setting to false will disable ANIS colors in the logging output
* `file`: provide a path to a file, and output will be logged there too
* `level`: case-insensitive logging level
* `report_caller`: setting to true will output the filename and line number
   where the logging call was made

With the opts defined, make the setup call:

```rust
    match twyg::setup_logger(&opts) {
        Ok(_) => {},
        Err(error) => {
            panic!("Could not setup logger: {:?}", error)
        },
    };
```

All subsequent calls to the standard Rust log functions will use this setup,
providing output like the following:

[![][screenshot-thumb]][screenshot]

The output in the screenshot above (click for a a full-sized view) is from
running the little demo in [main.rs](src/main.rs).

<!-- Named page links below: /-->

[logo]: resources/images/logo-250x.png
[logo-large]: resources/images/logo-1000x.png
[screenshot-thumb]: resources/images/screenshot-thumb.png
[screenshot]: resources/images/screenshot.png