Google Git
Sign in
android / platform / external / rust / crates / log / refs/tags/android-platform-13.0.0_r29
tagdc57fc4bcfcaafd11b286495bfa36edcd190d663
taggerThe Android Open Source Project <initial-contribution@android.com>Thu Mar 13 16:56:44 2025 -0700
objectafdbfdf2c8b02454abf6653037b781734b3b6fd5 
Android Platform 13.0.0 Release 29 (13077530)
commitafdbfdf2c8b02454abf6653037b781734b3b6fd5[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Tue Nov 01 21:32:01 2022 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Tue Nov 01 21:32:01 2022 +0000
tree1b3796cf8cc007111e8e3665619bfdeaf0b423b4
parent95efa88b3ce0efe99945793e104511c41bfdac64 [diff]
parent8ac021d067d70fb99375f5e7c120ea3b0332c34b [diff]
Snap for 9239618 from 8ac021d067d70fb99375f5e7c120ea3b0332c34b to tm-platform-release

Change-Id: I14393f69620a6da50c544d984752ba2105564539
tree: 1b3796cf8cc007111e8e3665619bfdeaf0b423b4
  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.