mirror of
https://gitee.com/openharmony/third_party_rust_log
synced 2024-11-30 11:20:28 +00:00
f7a14e41f2
win_dbg_logger is logger for use with Windows debuggers. Windows allows applications to output a string directly to debuggers. This is very useful in situations where other forms of logging are not available. For example, stderr is not available for GUI apps. This crate can be compiled and used on non-Windows platforms, but it does nothing. This is intended to minimize the impact on code that takes a dependency on this crate.
87 lines
3.2 KiB
Markdown
87 lines
3.2 KiB
Markdown
log
|
|
===
|
|
|
|
A Rust library providing a lightweight logging *facade*.
|
|
|
|
[](https://github.com/rust-lang/log/actions)
|
|
[](https://crates.io/crates/log)
|
|
[](https://docs.rs/log)
|
|
|
|
|
|
* [`log` documentation](https://docs.rs/log)
|
|
|
|
A logging facade provides a single logging API that abstracts over the actual
|
|
logging implementation. Libraries can use the logging API provided by this
|
|
crate, and the consumer of those libraries can choose the logging
|
|
implementation that is most suitable for its use case.
|
|
|
|
|
|
## Minimum supported `rustc`
|
|
|
|
`1.31.0+`
|
|
|
|
This version is explicitly tested in CI and may be bumped in any release as needed. Maintaining compatibility with older compilers is a priority though, so the bar for bumping the minimum supported version is set very high. Any changes to the supported minimum version will be called out in the release notes.
|
|
|
|
## Usage
|
|
|
|
## In libraries
|
|
|
|
Libraries should link only to the `log` crate, and use the provided macros to
|
|
log whatever information will be useful to downstream consumers:
|
|
|
|
```toml
|
|
[dependencies]
|
|
log = "0.4"
|
|
```
|
|
|
|
```rust
|
|
use log::{info, trace, warn};
|
|
|
|
pub fn shave_the_yak(yak: &mut Yak) {
|
|
trace!("Commencing yak shaving");
|
|
|
|
loop {
|
|
match find_a_razor() {
|
|
Ok(razor) => {
|
|
info!("Razor located: {}", razor);
|
|
yak.shave(razor);
|
|
break;
|
|
}
|
|
Err(err) => {
|
|
warn!("Unable to locate a razor: {}, retrying", err);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## In executables
|
|
|
|
In order to produce log output, executables have to use a logger implementation compatible with the facade.
|
|
There are many available implementations to chose from, here are some of the most popular ones:
|
|
|
|
* Simple minimal loggers:
|
|
* [`env_logger`](https://docs.rs/env_logger/*/env_logger/)
|
|
* [`simple_logger`](https://github.com/borntyping/rust-simple_logger)
|
|
* [`simplelog`](https://github.com/drakulix/simplelog.rs)
|
|
* [`pretty_env_logger`](https://docs.rs/pretty_env_logger/*/pretty_env_logger/)
|
|
* [`stderrlog`](https://docs.rs/stderrlog/*/stderrlog/)
|
|
* [`flexi_logger`](https://docs.rs/flexi_logger/*/flexi_logger/)
|
|
* Complex configurable frameworks:
|
|
* [`log4rs`](https://docs.rs/log4rs/*/log4rs/)
|
|
* [`fern`](https://docs.rs/fern/*/fern/)
|
|
* Adaptors for other facilities:
|
|
* [`syslog`](https://docs.rs/syslog/*/syslog/)
|
|
* [`slog-stdlog`](https://docs.rs/slog-stdlog/*/slog_stdlog/)
|
|
* [`android_log`](https://docs.rs/android_log/*/android_log/)
|
|
* [`win_dbg_logger`](https://docs.rs/win_dbg_logger/*/win_dbg_logger/)
|
|
* For WebAssembly binaries:
|
|
* [`console_log`](https://docs.rs/console_log/*/console_log/)
|
|
|
|
Executables should choose a logger implementation and initialize it early in the
|
|
runtime of the program. Logger implementations will typically include a
|
|
function to do this. Any log messages generated before the logger is
|
|
initialized will be ignored.
|
|
|
|
The executable itself may use the `log` crate to log as well.
|