83 lines
2.0 KiB
Markdown
83 lines
2.0 KiB
Markdown
# kt_log
|
|
|
|
[](https://git.moturpin.com/Matsubaa/kt_log/actions/workflows/build.yml)
|
|
[](https://git.moturpin.com/Matsubaa/kt_log/actions/workflows/test.yml)
|
|
|
|
Tiny console logger for Rust built on the `log` facade.
|
|
|
|
## Installation
|
|
|
|
This crate is published to the `gitea` Cargo registry hosted on git.moturpin.com.
|
|
|
|
1) Tell Cargo about the registry (once per machine/workspace), e.g. in `.cargo/config.toml`:
|
|
|
|
```
|
|
[registries.gitea]
|
|
index = "sparse+https://git.moturpin.com/api/packages/Matsubaa/cargo/"
|
|
```
|
|
|
|
2) Add the dependency to your `Cargo.toml`:
|
|
|
|
```
|
|
[dependencies]
|
|
kt_log = { version = "0.1", registry = "gitea" }
|
|
```
|
|
|
|
If the registry is private, authenticate with:
|
|
|
|
```
|
|
cargo login --registry gitea <TOKEN>
|
|
```
|
|
|
|
## Usage
|
|
|
|
Initialize the logger once at program start, then use the standard `log` macros. Messages at `Error`, `Warn`, and `Info` are printed; `Debug` and `Trace` are ignored by default.
|
|
|
|
```rust
|
|
use kt_log::init;
|
|
use log::{error, warn, info, debug, trace};
|
|
|
|
fn main() {
|
|
init().expect("failed to init logger");
|
|
|
|
error!("something failed");
|
|
warn!("watch out");
|
|
info!("hello {}", "world");
|
|
debug!("this will not be shown");
|
|
trace!("this will not be shown either");
|
|
}
|
|
```
|
|
|
|
Example output:
|
|
|
|
```
|
|
[ERROR] something failed
|
|
[WARN] watch out
|
|
[INFO] hello world
|
|
```
|
|
|
|
## Features
|
|
|
|
- Minimal, zero-config console logger
|
|
- Built on `log` 0.4 — works with the standard logging macros
|
|
- Simple output format: `[LEVEL] message`
|
|
- Default max level: `Info` (prints `Error`, `Warn`, `Info`)
|
|
|
|
## Notes & Limitations
|
|
|
|
- The maximum log level is currently fixed to `Info` at initialization time.
|
|
- `Debug` and `Trace` messages are intentionally not printed.
|
|
|
|
## Development
|
|
|
|
- Build: `cargo build`
|
|
- Test: `cargo test`
|
|
|
|
## License
|
|
|
|
Licensed under the MIT License. See [LICENSE](LICENSE).
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md).
|