log4rc 0.3.0

A log4j-like logging framework for Rust
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# log4rc

A log4j-like logging framework for Rust.

## Overview

`log4rc` is a simple, extensible logging framework inspired by log4j. It provides different log levels and an easy-to-use API for Rust applications.

## Features

- Multiple log levels (Trace, Debug, Info, Warn, Error)
- Simple API similar to log4j
- Thread-safe logging
- Timestamped log entries
- Configurable log levels
- File appender (append logs to disk)
- Cheap to disable: filtered-out levels skip formatting entirely

## Installation

Add this to your `Cargo.toml`:

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

## Example

```rust
use log4rc::{LogLevel, Logger};

fn main() {
    // Initialize the logger with Debug level
    Logger::init(LogLevel::Debug);
    
    // Test all log levels
    log4rc::trace!("This is a trace message - won't be printed");
    log4rc::debug!("This is a debug message - will be printed");
    log4rc::info!("This is an info message - will be printed");
    log4rc::warn!("This is a warning message - will be printed");
    log4rc::error!("This is an error message - will be printed");
}
```

## Custom appenders

`log4rc` is extensible: implement the `Appender` trait (output target) and the `Layout` trait (message formatting), then build a logger with `Logger::builder`.

```rust
use log4rc::{Appender, LogEvent, LogLevel, Logger, SimpleLayout};

struct MyAppender;

impl Appender for MyAppender {
    fn append(&self, event: &LogEvent) {
        // Write `event.message` somewhere, e.g. a file or a network socket
    }
}

fn main() {
    Logger::builder(LogLevel::Debug)
        .appender(Box::new(MyAppender))
        .init();
}
```

You can add multiple appenders, and `Logger::init` remains a shortcut that installs a console appender with the default layout.

### File appender

`FileAppender` appends formatted events to a file (creating it if needed) and flushes after every event:

```rust
use log4rc::{ConsoleAppender, FileAppender, LogLevel, Logger, SimpleLayout};

Logger::builder(LogLevel::Info)
    .appender(Box::new(ConsoleAppender::new(Box::new(SimpleLayout))))
    .appender(Box::new(FileAppender::open("app.log", Box::new(SimpleLayout)).unwrap()))
    .init();
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.