Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / log / a8e3113829975a02f5d13f1bead9be14a4e24cd5
commita8e3113829975a02f5d13f1bead9be14a4e24cd5[log] [tgz]
authorJoel Galenson <jgalenson@google.com>Wed Dec 15 18:06:35 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Wed Dec 15 18:06:35 2021 +0000
treea0cc5d6d89f4ceaecf04e6b97fe55910e757ab9c
parente199ed9a67b3b143623bac17bc5d52e11efcd8ee [diff]
parent586bc7a0fbc66ba728d0d839633275cc67a02f71 [diff]
Merge "Refresh Android.bp, cargo2android.json, TEST_MAPPING." am: d3a6baa591 am: 9d916395fb am: 7bfb0637e5 am: 586bc7a0fb

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

Change-Id: Ic150f3e8769f158f97f0dcd6ce9ae9ebe9f7f2c9
tree: a0cc5d6d89f4ceaecf04e6b97fe55910e757ab9c
  1. .github/
  2. benches/
  3. src/
  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. cargo2android.json
  12. CHANGELOG.md
  13. LICENSE-APACHE
  14. LICENSE-MIT
  15. METADATA
  16. MODULE_LICENSE_APACHE2
  17. OWNERS
  18. README.md
  19. TEST_MAPPING
  20. 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.