Google Git
Sign in
android / platform / external / rust / crates / log / c493c494da486a302eb5a2a33137c53ebe04816e
commitc493c494da486a302eb5a2a33137c53ebe04816e[log] [tgz]
authorXin Li <delphij@google.com>Fri Oct 09 03:22:57 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Oct 09 03:22:57 2020 +0000
tree97a248c8a928172c5b4e24ddd694099342909a35
parentfe13896cb2084164c53f16410015a824c0e2b625 [diff]
parentba92b1698c73be8fc6a1886d14a64a51365e5102 [diff]
[automerger skipped] Skip ab/6749736 in stage. am: 49b0bcd0be -s ours am: ba92b1698c -s ours

am skip reason: Change-Id I3996e3f29c99b1a17e99f0a9b3e3d793432a701b with SHA-1 5fa404d8d0 is in history

Original change: https://googleplex-android-review.googlesource.com/c/platform/external/rust/crates/log/+/12797359

Change-Id: I3f786d73ea1cee935a92b56a6fb7b7fb0f124a50
tree: 97a248c8a928172c5b4e24ddd694099342909a35
  1. .github/
  2. src/
  3. tests/
  4. LICENSE ⇨ LICENSE-APACHE
  5. .cargo_vcs_info.json
  6. .gitignore
  7. Android.bp
  8. build.rs
  9. Cargo.toml
  10. Cargo.toml.orig
  11. CHANGELOG.md
  12. LICENSE-APACHE
  13. LICENSE-MIT
  14. METADATA
  15. MODULE_LICENSE_APACHE2
  16. OWNERS
  17. README.md
  18. triagebot.toml
README.md

log

A Rust library providing a lightweight logging facade.

Build status Latest version Documentation License

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:

[dependencies]
log = "0.4"

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 choose from, here are some of the most popular ones:

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.