log-0.4.20/.cargo_vcs_info.json0000644000000001360000000000100117000ustar { "git": { "sha1": "4708f1484c7e6b8d4418b571c05e613b18e57673" }, "path_in_vcs": "" }log-0.4.20/.github/workflows/main.yml000064400000000000000000000116621046102023000155420ustar 00000000000000name: CI on: [push, pull_request] permissions: contents: read # to fetch code (actions/checkout) jobs: test: name: Test runs-on: ${{ matrix.os }} strategy: matrix: build: [stable, beta, nightly, macos, win32, win64, mingw] include: - build: stable os: ubuntu-latest rust: stable - build: beta os: ubuntu-latest rust: beta - build: nightly os: ubuntu-latest rust: nightly - build: macos os: macos-latest rust: stable - build: win32 os: windows-latest rust: stable-i686-pc-windows-msvc - build: win64 os: windows-latest rust: stable-x86_64-pc-windows-msvc - build: mingw os: windows-latest rust: stable-x86_64-pc-windows-gnu steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update ${{ matrix.rust }} --no-self-update rustup default ${{ matrix.rust }} - run: cargo test --verbose - run: cargo test --verbose --no-default-features - run: cargo test --verbose --all-features - run: cargo test --verbose --features serde - run: cargo test --verbose --features std - run: cargo test --verbose --features kv_unstable - run: cargo test --verbose --features kv_unstable_sval - run: cargo test --verbose --features kv_unstable_serde - run: cargo test --verbose --features "kv_unstable kv_unstable_std kv_unstable_sval kv_unstable_serde" - run: cargo run --verbose --manifest-path test_max_level_features/Cargo.toml - run: cargo run --verbose --manifest-path test_max_level_features/Cargo.toml --release rustfmt: name: Rustfmt runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update stable --no-self-update rustup default stable rustup component add rustfmt - run: cargo fmt -- --check clippy: name: Clippy runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update stable --no-self-update rustup default stable rustup component add clippy - run: cargo clippy --verbose doc: name: Check Documentation runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update stable --no-self-update rustup default stable rustup component add rust-docs - name: Run rustdoc run: RUSTDOCFLAGS="-D warnings" cargo doc --verbose --all-features features: name: Feature check runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update nightly --no-self-update rustup default nightly - run: cargo build --verbose -Z avoid-dev-deps --features kv_unstable - run: cargo build --verbose -Z avoid-dev-deps --features "kv_unstable std" - run: cargo build --verbose -Z avoid-dev-deps --features "kv_unstable kv_unstable_sval" - run: cargo build --verbose -Z avoid-dev-deps --features "kv_unstable kv_unstable_serde" - run: cargo build --verbose -Z avoid-dev-deps --features "kv_unstable kv_unstable_std" - run: cargo build --verbose -Z avoid-dev-deps --features "kv_unstable kv_unstable_sval kv_unstable_serde" minimalv: name: Minimal versions runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update nightly --no-self-update rustup default nightly - run: cargo build --verbose -Z minimal-versions --features kv_unstable - run: cargo build --verbose -Z minimal-versions --features "kv_unstable std" - run: cargo build --verbose -Z minimal-versions --features "kv_unstable kv_unstable_sval" - run: cargo build --verbose -Z minimal-versions --features "kv_unstable kv_unstable_serde" - run: cargo build --verbose -Z minimal-versions --features "kv_unstable kv_unstable_std" - run: cargo build --verbose -Z minimal-versions --features "kv_unstable kv_unstable_sval kv_unstable_serde" msrv: name: MSRV runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update 1.60.0 --no-self-update rustup default 1.60.0 - run: cargo test --verbose --manifest-path tests/Cargo.toml embedded: name: Embedded runs-on: ubuntu-latest steps: - uses: actions/checkout@master - name: Install Rust run: | rustup update stable --no-self-update rustup default stable - run: rustup target add thumbv6m-none-eabi riscv32imc-unknown-none-elf - run: cargo build --verbose --target=thumbv6m-none-eabi - run: cargo build --verbose --target=riscv32imc-unknown-none-elf log-0.4.20/.gitignore000064400000000000000000000000231046102023000124530ustar 00000000000000target/ Cargo.lock log-0.4.20/CHANGELOG.md000064400000000000000000000272721046102023000123130ustar 00000000000000# Change Log ## [Unreleased] ## [0.4.20] - 2023-07-11 * Remove rustversion dev-dependency by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/568 * Remove `local_inner_macros` usage by @EFanZh in https://github.com/rust-lang/log/pull/570 ## [0.4.19] - 2023-06-10 * Use target_has_atomic instead of the old atomic_cas cfg by @GuillaumeGomez in https://github.com/rust-lang/log/pull/555 * Put MSRV into Cargo.toml by @est31 in https://github.com/rust-lang/log/pull/557 ## [0.4.18] - 2023-05-28 * fix markdown links (again) by @hellow554 in https://github.com/rust-lang/log/pull/513 * add cargo doc to workflow by @hellow554 in https://github.com/rust-lang/log/pull/515 * Apply Clippy lints by @hellow554 in https://github.com/rust-lang/log/pull/516 * Replace ad-hoc eq_ignore_ascii_case with slice::eq_ignore_ascii_case by @glandium in https://github.com/rust-lang/log/pull/519 * fix up windows targets by @KodrAus in https://github.com/rust-lang/log/pull/528 * typo fix by @jiangying000 in https://github.com/rust-lang/log/pull/529 * Remove dependency on cfg_if by @EriKWDev in https://github.com/rust-lang/log/pull/536 * GitHub Workflows security hardening by @sashashura in https://github.com/rust-lang/log/pull/538 * Fix build status badge by @atouchet in https://github.com/rust-lang/log/pull/539 * Add call_logger to the documentation by @a1ecbr0wn in https://github.com/rust-lang/log/pull/547 * Use stable internals for key-value API by @KodrAus in https://github.com/rust-lang/log/pull/550 * Change wording of list of implementations by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/553 * Add std-logger to list of implementations by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/554 * Add `set_max_level_racy` and gate `set_max_level` by @djkoloski in https://github.com/rust-lang/log/pull/544 * [doc] src/lib.rs : prefix an unused variable with an underscore by @OccupyMars2025 in https://github.com/rust-lang/log/pull/561 * [doc] src/macros.rs : correct grammar errors of an example in lib documentation by @OccupyMars2025 in https://github.com/rust-lang/log/pull/562 ## [0.4.17] - 2022-04-29 * Update `kv_unstable` internal dependencies. ## [0.4.16] - 2022-03-22 * Fix a conflict with unqualified `Option` use in macros. ## [0.4.15] - 2022-02-23 * Silence a warning about the deprecated `spin_loop_hint`. * Relax ordering in the atomic `set_max_level` call. * Add thumbv4t-none-eabi to targets that don't support atomics * Allow levels to be iterated over. * Implement `Log` on some common wrapper types. * Improvements to test coverage. * Improvements to documentation. * Add key-value support to the `log!` macros. * Tighten `kv_unstable` internal dependencies so they don't bump past their current alpha. * Add a simple visit API to `kv_unstable`. * Support `NonZero*` integers as values in structured logging * Support static strings as keys in structured logging ## [0.4.14] - 2021-01-27 * Remove the `__private_api_log_lit` special case. * Fixed incorrect combination of `kv_unstable` and `std` features causing compile failures. * Remove unstable `Value::to_*` conversions that were incorrectly using `as`. * Rename unstable `Value::to_error` to `Value::to_borrowed_error`. ## [0.4.13] - 2021-01-11 * This is the same as `0.4.11`, except with a `kv_unstable_std` feature added to aid migrating current dependents to `0.4.14` (which was originally going to be `0.4.13` until it was decided to create a patch from `0.4.11` to minimize disruption). ## [0.4.12] - 2020-12-24 ### New * Support platforms without atomics by racing instead of failing to compile * Implement `Log` for `Box` * Update `cfg-if` to `1.0` * Internal reworks of the structured logging API. Removed the `Fill` API and added `source::as_map` and `source::as_list` to easily serialize a `Source` as either a map of `{key: value, ..}` or as a list of `[(key, value), ..]`. ### Fixed * Fixed deserialization of `LevelFilter` to use their `u64` index variants ## [0.4.11] - 2020-07-09 ### New * Support coercing structured values into concrete types. * Reference the `win_dbg_logger` in the readme. ### Fixed * Updates a few deprecated items used internally. * Fixed issues in docs and expands sections. * Show the correct build badge in the readme. * Fix up a possible inference breakage with structured value errors. * Respect formatting flags in structured value formatting. ## [0.4.10] - 2019-12-16 (yanked) ### Fixed * Fixed the `log!` macros so they work in expression context (this regressed in `0.4.9`, which has been yanked). ## [0.4.9] - 2019-12-12 (yanked) ### Minimum Supported Rust Version This release bumps the minimum compiler version to `1.31.0`. This was mainly needed for `cfg-if`, but between `1.16.0` and `1.31.0` there are a lot of language and library improvements we now take advantage of. ### New * Unstable support for capturing key-value pairs in a record using the `log!` macros ### Improved * Better documentation for max level filters. * Internal updates to line up with bumped MSRV ## [0.4.8] - 2019-07-28 ### New * Support attempting to get `Record` fields as static strings. ## [0.4.7] - 2019-07-06 ### New * Support for embedded environments with thread-unsafe initialization. * Initial unstable support for capturing structured data under the `kv_unstable` feature gate. This new API doesn't affect existing users and may change in future patches (so those changes may not appear in the changelog until it stabilizes). ### Improved * Docs for using `log` with the 2018 edition. * Error messages for macros missing arguments. ## [0.4.6] - 2018-10-27 ### Improved * Support 2018-style macro import for the `log_enabled!` macro. ## [0.4.5] - 2018-09-03 ### Improved * Make `log`'s internal helper macros less likely to conflict with user-defined macros. ## [0.4.4] - 2018-08-17 ### Improved * Support 2018-style imports of the log macros. ## [0.4.3] - 2018-06-29 ### Improved * More code generation improvements. ## [0.4.2] - 2018-06-05 ### Improved * Log invocations now generate less code. ### Fixed * Example Logger implementations now properly set the max log level. ## [0.4.1] - 2017-12-30 ### Fixed * Some doc links were fixed. ## [0.4.0] - 2017-12-24 The changes in this release include cleanup of some obscure functionality and a more robust public API designed to support bridges to other logging systems, and provide more flexibility to new features in the future. ### Compatibility Vast portions of the Rust ecosystem use the 0.3.x release series of log, and we don't want to force the community to go through the pain of upgrading every crate to 0.4.x at the exact same time. Along with 0.4.0, we've published a new 0.3.9 release which acts as a "shim" over 0.4.0. This will allow crates using either version to coexist without losing messages from one side or the other. There is one caveat - a log message generated by a crate using 0.4.x but consumed by a logging implementation using 0.3.x will not have a file name or module path. Applications affected by this can upgrade their logging implementations to one using 0.4.x to avoid losing this information. The other direction does not lose any information, fortunately! **TL;DR** Libraries should feel comfortable upgrading to 0.4.0 without treating that as a breaking change. Applications may need to update their logging implementation (e.g. env-logger) to a newer version using log 0.4.x to avoid losing module and file information. ### New * The crate is now `no_std` by default. * `Level` and `LevelFilter` now implement `Serialize` and `Deserialize` when the `serde` feature is enabled. * The `Record` and `Metadata` types can now be constructed by third-party code via a builder API. * The `logger` free function returns a reference to the logger implementation. This, along with the ability to construct `Record`s, makes it possible to bridge from another logging framework to this one without digging into the private internals of the crate. The standard `error!` `warn!`, etc, macros now exclusively use the public API of the crate rather than "secret" internal APIs. * `Log::flush` has been added to allow crates to tell the logging implementation to ensure that all "in flight" log events have been persisted. This can be used, for example, just before an application exits to ensure that asynchronous log sinks finish their work. ### Removed * The `shutdown` and `shutdown_raw` functions have been removed. Supporting shutdown significantly complicated the implementation and imposed a performance cost on each logging operation. * The `log_panics` function and its associated `nightly` Cargo feature have been removed. Use the [log-panics](https://crates.io/crates/log-panics) instead. ### Changed * The `Log` prefix has been removed from type names. For example, `LogLevelFilter` is now `LevelFilter`, and `LogRecord` is now `Record`. * The `MaxLogLevelFilter` object has been removed in favor of a `set_max_level` free function. * The `set_logger` free functions have been restructured. The logger is now directly passed to the functions rather than a closure which returns the logger. `set_logger` now takes a `&'static Log` and is usable in `no_std` contexts in place of the old `set_logger_raw`. `set_boxed_logger` is a convenience function which takes a `Box` but otherwise acts like `set_logger`. It requires the `std` feature. * The `file` and `module_path` values in `Record` no longer have the `'static` lifetime to support integration with other logging frameworks that don't provide a `'static` lifetime for the equivalent values. * The `file`, `line`, and `module_path` values in `Record` are now `Option`s to support integration with other logging frameworks that don't provide those values. ### In the Future * We're looking to add support for *structured* logging - the inclusion of extra key-value pairs of information in a log event in addition to the normal string message. This should be able to be added in a backwards compatible manner to the 0.4.x series when the design is worked out. ## Older Look at the [release tags] for information about older releases. [Unreleased]: https://github.com/rust-lang-nursery/log/compare/0.4.18...HEAD [0.4.20]: https://github.com/rust-lang-nursery/log/compare/0.4.19...0.4.20 [0.4.19]: https://github.com/rust-lang-nursery/log/compare/0.4.18...0.4.19 [0.4.18]: https://github.com/rust-lang-nursery/log/compare/0.4.17...0.4.18 [0.4.17]: https://github.com/rust-lang-nursery/log/compare/0.4.16...0.4.17 [0.4.16]: https://github.com/rust-lang-nursery/log/compare/0.4.15...0.4.16 [0.4.15]: https://github.com/rust-lang-nursery/log/compare/0.4.13...0.4.15 [0.4.14]: https://github.com/rust-lang-nursery/log/compare/0.4.13...0.4.14 [0.4.13]: https://github.com/rust-lang-nursery/log/compare/0.4.11...0.4.13 [0.4.12]: https://github.com/rust-lang-nursery/log/compare/0.4.11...0.4.12 [0.4.11]: https://github.com/rust-lang-nursery/log/compare/0.4.10...0.4.11 [0.4.10]: https://github.com/rust-lang-nursery/log/compare/0.4.9...0.4.10 [0.4.9]: https://github.com/rust-lang-nursery/log/compare/0.4.8...0.4.9 [0.4.8]: https://github.com/rust-lang-nursery/log/compare/0.4.7...0.4.8 [0.4.7]: https://github.com/rust-lang-nursery/log/compare/0.4.6...0.4.7 [0.4.6]: https://github.com/rust-lang-nursery/log/compare/0.4.5...0.4.6 [0.4.5]: https://github.com/rust-lang-nursery/log/compare/0.4.4...0.4.5 [0.4.4]: https://github.com/rust-lang-nursery/log/compare/0.4.3...0.4.4 [0.4.3]: https://github.com/rust-lang-nursery/log/compare/0.4.2...0.4.3 [0.4.2]: https://github.com/rust-lang-nursery/log/compare/0.4.1...0.4.2 [0.4.1]: https://github.com/rust-lang-nursery/log/compare/0.4.0...0.4.1 [0.4.0]: https://github.com/rust-lang-nursery/log/compare/0.3.8...0.4.0 [release tags]: https://github.com/rust-lang-nursery/log/releases log-0.4.20/Cargo.toml0000644000000045320000000000100077020ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] rust-version = "1.60.0" name = "log" version = "0.4.20" authors = ["The Rust Project Developers"] exclude = ["rfcs/**/*"] description = """ A lightweight logging facade for Rust """ documentation = "https://docs.rs/log" readme = "README.md" keywords = ["logging"] categories = ["development-tools::debugging"] license = "MIT OR Apache-2.0" repository = "https://github.com/rust-lang/log" [package.metadata.docs.rs] features = [ "std", "serde", "kv_unstable_std", "kv_unstable_sval", "kv_unstable_serde", ] [[test]] name = "filters" path = "tests/filters.rs" harness = false [[test]] name = "macros" path = "tests/macros.rs" harness = true [dependencies.serde] version = "1.0" optional = true default-features = false [dependencies.sval] version = "2.1" optional = true default-features = false [dependencies.sval_ref] version = "2.1" optional = true default-features = false [dependencies.value-bag] version = "1.4" optional = true default-features = false [dev-dependencies.proc-macro2] version = "1.0.63" default-features = false [dev-dependencies.serde] version = "1.0" features = ["derive"] [dev-dependencies.serde_test] version = "1.0" [dev-dependencies.sval] version = "2.1" [dev-dependencies.sval_derive] version = "2.1" [dev-dependencies.value-bag] version = "1.4" features = ["test"] [features] kv_unstable = ["value-bag"] kv_unstable_serde = [ "kv_unstable_std", "value-bag/serde", "serde", ] kv_unstable_std = [ "std", "kv_unstable", "value-bag/error", ] kv_unstable_sval = [ "kv_unstable", "value-bag/sval", "sval", "sval_ref", ] max_level_debug = [] max_level_error = [] max_level_info = [] max_level_off = [] max_level_trace = [] max_level_warn = [] release_max_level_debug = [] release_max_level_error = [] release_max_level_info = [] release_max_level_off = [] release_max_level_trace = [] release_max_level_warn = [] std = [] log-0.4.20/Cargo.toml.orig000064400000000000000000000044211046102023000133600ustar 00000000000000[package] name = "log" version = "0.4.20" # remember to update html_root_url authors = ["The Rust Project Developers"] license = "MIT OR Apache-2.0" readme = "README.md" repository = "https://github.com/rust-lang/log" documentation = "https://docs.rs/log" description = """ A lightweight logging facade for Rust """ categories = ["development-tools::debugging"] keywords = ["logging"] exclude = ["rfcs/**/*"] rust-version = "1.60.0" [package.metadata.docs.rs] features = ["std", "serde", "kv_unstable_std", "kv_unstable_sval", "kv_unstable_serde"] [[test]] name = "filters" path = "tests/filters.rs" harness = false [[test]] name = "macros" path = "tests/macros.rs" harness = true [features] max_level_off = [] max_level_error = [] max_level_warn = [] max_level_info = [] max_level_debug = [] max_level_trace = [] release_max_level_off = [] release_max_level_error = [] release_max_level_warn = [] release_max_level_info = [] release_max_level_debug = [] release_max_level_trace = [] std = [] # requires the latest stable # this will have a tighter MSRV before stabilization kv_unstable = ["value-bag"] kv_unstable_sval = ["kv_unstable", "value-bag/sval", "sval", "sval_ref"] kv_unstable_std = ["std", "kv_unstable", "value-bag/error"] kv_unstable_serde = ["kv_unstable_std", "value-bag/serde", "serde"] [dependencies] serde = { version = "1.0", optional = true, default-features = false } sval = { version = "2.1", optional = true, default-features = false } sval_ref = { version = "2.1", optional = true, default-features = false } value-bag = { version = "1.4", optional = true, default-features = false } [dev-dependencies] serde = { version = "1.0", features = ["derive"] } serde_test = "1.0" sval = { version = "2.1" } sval_derive = { version = "2.1" } value-bag = { version = "1.4", features = ["test"] } # NOTE: log doesn't actually depent on this crate. However our dependencies, # serde and sval, dependent on version 1.0 of the crate, which has problem fixed # in 1.0.60, specifically in the following commit # https://github.com/dtolnay/proc-macro2/commit/e31d61910049e097afdd3d27c37786309082bdcb. # By defining the crate as direct dependency we can increase it's minimal # version making the minimal (crate) version CI happy. proc-macro2 = { version = "1.0.63", default-features = false } log-0.4.20/LICENSE-APACHE000064400000000000000000000251371046102023000124240ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. log-0.4.20/LICENSE-MIT000064400000000000000000000020571046102023000121300ustar 00000000000000Copyright (c) 2014 The Rust Project Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. log-0.4.20/README.md000064400000000000000000000107171046102023000117550ustar 00000000000000log === A Rust library providing a lightweight logging *facade*. [![Build status](https://img.shields.io/github/actions/workflow/status/rust-lang/log/main.yml?branch=master)](https://github.com/rust-lang/log/actions) [![Latest version](https://img.shields.io/crates/v/log.svg)](https://crates.io/crates/log) [![Documentation](https://docs.rs/log/badge.svg)](https://docs.rs/log) ![License](https://img.shields.io/crates/l/log.svg) * [`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.60.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 choose from, here are some options: * Simple minimal loggers: * [`env_logger`](https://docs.rs/env_logger/*/env_logger/) * [`simple_logger`](https://docs.rs/simple_logger/*/simple_logger/) * [`simplelog`](https://docs.rs/simplelog/*/simplelog/) * [`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/) * [`call_logger`](https://docs.rs/call_logger/*/call_logger/) * [`std-logger`](https://docs.rs/std-logger/*/std_logger/) * [`structured-logger`](https://docs.rs/structured-logger/latest/structured_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/) * [`systemd-journal-logger`](https://docs.rs/systemd-journal-logger/*/systemd_journal_logger/) * [`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/) * [`db_logger`](https://docs.rs/db_logger/*/db_logger/) * [`log-to-defmt`](https://docs.rs/log-to-defmt/*/log_to_defmt/) * For WebAssembly binaries: * [`console_log`](https://docs.rs/console_log/*/console_log/) * For dynamic libraries: * You may need to construct [an FFI-safe wrapper over `log`](https://github.com/rust-lang/log/issues/421) to initialize in your libraries. * Utilities: * [`log_err`](https://docs.rs/log_err/*/log_err/) 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. ## Structured logging If you enable the `kv_unstable` feature, you can associate structured data with your log records: ```rust use log::{info, trace, warn, as_serde, as_error}; pub fn shave_the_yak(yak: &mut Yak) { trace!(target = "yak_events", yak = as_serde!(yak); "Commencing yak shaving"); loop { match find_a_razor() { Ok(razor) => { info!(razor = razor; "Razor located"); yak.shave(razor); break; } Err(err) => { warn!(err = as_error!(err); "Unable to locate a razor, retrying"); } } } } ``` log-0.4.20/benches/value.rs000064400000000000000000000010231046102023000135550ustar 00000000000000#![cfg(feature = "kv_unstable")] #![feature(test)] extern crate log; extern crate test; use log::kv::Value; #[bench] fn u8_to_value(b: &mut test::Bencher) { b.iter(|| Value::from(1u8)) } #[bench] fn u8_to_value_debug(b: &mut test::Bencher) { b.iter(|| Value::from_debug(&1u8)) } #[bench] fn str_to_value_debug(b: &mut test::Bencher) { b.iter(|| Value::from_debug(&"a string")) } #[bench] fn custom_to_value_debug(b: &mut test::Bencher) { #[derive(Debug)] struct A; b.iter(|| Value::from_debug(&A)) } log-0.4.20/src/__private_api.rs000064400000000000000000000031411046102023000144250ustar 00000000000000//! WARNING: this is not part of the crate's public API and is subject to change at any time use crate::{Level, Metadata, Record}; use std::fmt::Arguments; pub use std::option::Option; pub use std::{file, format_args, line, module_path, stringify}; #[cfg(not(feature = "kv_unstable"))] pub fn log( args: Arguments, level: Level, &(target, module_path, file): &(&str, &'static str, &'static str), line: u32, kvs: Option<&[(&str, &str)]>, ) { if kvs.is_some() { panic!( "key-value support is experimental and must be enabled using the `kv_unstable` feature" ) } crate::logger().log( &Record::builder() .args(args) .level(level) .target(target) .module_path_static(Some(module_path)) .file_static(Some(file)) .line(Some(line)) .build(), ); } #[cfg(feature = "kv_unstable")] pub fn log( args: Arguments, level: Level, &(target, module_path, file): &(&str, &'static str, &'static str), line: u32, kvs: Option<&[(&str, &dyn crate::kv::ToValue)]>, ) { crate::logger().log( &Record::builder() .args(args) .level(level) .target(target) .module_path_static(Some(module_path)) .file_static(Some(file)) .line(Some(line)) .key_values(&kvs) .build(), ); } pub fn enabled(level: Level, target: &str) -> bool { crate::logger().enabled(&Metadata::builder().level(level).target(target).build()) } log-0.4.20/src/kv/error.rs000064400000000000000000000041231046102023000133760ustar 00000000000000use std::fmt; /// An error encountered while working with structured data. #[derive(Debug)] pub struct Error { inner: Inner, } #[derive(Debug)] enum Inner { #[cfg(feature = "std")] Boxed(std_support::BoxedError), Msg(&'static str), Value(value_bag::Error), Fmt, } impl Error { /// Create an error from a message. pub fn msg(msg: &'static str) -> Self { Error { inner: Inner::Msg(msg), } } // Not public so we don't leak the `value_bag` API pub(super) fn from_value(err: value_bag::Error) -> Self { Error { inner: Inner::Value(err), } } // Not public so we don't leak the `value_bag` API pub(super) fn into_value(self) -> value_bag::Error { match self.inner { Inner::Value(err) => err, #[cfg(feature = "kv_unstable_std")] _ => value_bag::Error::boxed(self), #[cfg(not(feature = "kv_unstable_std"))] _ => value_bag::Error::msg("error inspecting a value"), } } } impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { use self::Inner::*; match &self.inner { #[cfg(feature = "std")] &Boxed(ref err) => err.fmt(f), &Value(ref err) => err.fmt(f), &Msg(ref msg) => msg.fmt(f), &Fmt => fmt::Error.fmt(f), } } } impl From for Error { fn from(_: fmt::Error) -> Self { Error { inner: Inner::Fmt } } } #[cfg(feature = "std")] mod std_support { use super::*; use std::{error, io}; pub(super) type BoxedError = Box; impl Error { /// Create an error from a standard error type. pub fn boxed(err: E) -> Self where E: Into, { Error { inner: Inner::Boxed(err.into()), } } } impl error::Error for Error {} impl From for Error { fn from(err: io::Error) -> Self { Error::boxed(err) } } } log-0.4.20/src/kv/key.rs000064400000000000000000000062171046102023000130430ustar 00000000000000//! Structured keys. use std::borrow::Borrow; use std::fmt; /// A type that can be converted into a [`Key`](struct.Key.html). pub trait ToKey { /// Perform the conversion. fn to_key(&self) -> Key; } impl<'a, T> ToKey for &'a T where T: ToKey + ?Sized, { fn to_key(&self) -> Key { (**self).to_key() } } impl<'k> ToKey for Key<'k> { fn to_key(&self) -> Key { Key { key: self.key } } } impl ToKey for str { fn to_key(&self) -> Key { Key::from_str(self) } } /// A key in a structured key-value pair. // These impls must only be based on the as_str() representation of the key // If a new field (such as an optional index) is added to the key they must not affect comparison #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct Key<'k> { key: &'k str, } impl<'k> Key<'k> { /// Get a key from a borrowed string. pub fn from_str(key: &'k str) -> Self { Key { key } } /// Get a borrowed string from this key. pub fn as_str(&self) -> &str { self.key } /// Try get a string borrowed for the `'k` lifetime from this key. pub fn to_borrowed_str(&self) -> Option<&'k str> { // NOTE: This API leaves room for keys to be owned Some(self.key) } } impl<'k> fmt::Display for Key<'k> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { self.key.fmt(f) } } impl<'k> AsRef for Key<'k> { fn as_ref(&self) -> &str { self.as_str() } } impl<'k> Borrow for Key<'k> { fn borrow(&self) -> &str { self.as_str() } } impl<'k> From<&'k str> for Key<'k> { fn from(s: &'k str) -> Self { Key::from_str(s) } } #[cfg(feature = "std")] mod std_support { use super::*; use std::borrow::Cow; impl ToKey for String { fn to_key(&self) -> Key { Key::from_str(self) } } impl<'a> ToKey for Cow<'a, str> { fn to_key(&self) -> Key { Key::from_str(self) } } } #[cfg(feature = "kv_unstable_sval")] mod sval_support { use super::*; extern crate sval; extern crate sval_ref; use self::sval::Value; use self::sval_ref::ValueRef; impl<'a> Value for Key<'a> { fn stream<'sval, S: sval::Stream<'sval> + ?Sized>( &'sval self, stream: &mut S, ) -> sval::Result { self.key.stream(stream) } } impl<'a> ValueRef<'a> for Key<'a> { fn stream_ref + ?Sized>( &self, stream: &mut S, ) -> self::sval::Result { self.key.stream(stream) } } } #[cfg(feature = "kv_unstable_serde")] mod serde_support { use super::*; extern crate serde; use self::serde::{Serialize, Serializer}; impl<'a> Serialize for Key<'a> { fn serialize(&self, serializer: S) -> Result where S: Serializer, { self.key.serialize(serializer) } } } #[cfg(test)] mod tests { use super::*; #[test] fn key_from_string() { assert_eq!("a key", Key::from_str("a key").as_str()); } } log-0.4.20/src/kv/mod.rs000064400000000000000000000011331046102023000130220ustar 00000000000000//! **UNSTABLE:** Structured key-value pairs. //! //! This module is unstable and breaking changes may be made //! at any time. See [the tracking issue](https://github.com/rust-lang-nursery/log/issues/328) //! for more details. //! //! Add the `kv_unstable` feature to your `Cargo.toml` to enable //! this module: //! //! ```toml //! [dependencies.log] //! features = ["kv_unstable"] //! ``` mod error; mod key; pub mod source; pub mod value; pub use self::error::Error; pub use self::key::{Key, ToKey}; pub use self::source::{Source, Visitor}; #[doc(inline)] pub use self::value::{ToValue, Value}; log-0.4.20/src/kv/source.rs000064400000000000000000000505241046102023000135530ustar 00000000000000//! Sources for key-value pairs. #[cfg(feature = "kv_unstable_sval")] extern crate sval; #[cfg(feature = "kv_unstable_sval")] extern crate sval_ref; #[cfg(feature = "kv_unstable_serde")] extern crate serde; use kv::{Error, Key, ToKey, ToValue, Value}; use std::fmt; /// A source of key-value pairs. /// /// The source may be a single pair, a set of pairs, or a filter over a set of pairs. /// Use the [`Visitor`](trait.Visitor.html) trait to inspect the structured data /// in a source. pub trait Source { /// Visit key-value pairs. /// /// A source doesn't have to guarantee any ordering or uniqueness of key-value pairs. /// If the given visitor returns an error then the source may early-return with it, /// even if there are more key-value pairs. /// /// # Implementation notes /// /// A source should yield the same key-value pairs to a subsequent visitor unless /// that visitor itself fails. fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error>; /// Get the value for a given key. /// /// If the key appears multiple times in the source then which key is returned /// is implementation specific. /// /// # Implementation notes /// /// A source that can provide a more efficient implementation of this method /// should override it. #[cfg(not(test))] fn get<'v>(&'v self, key: Key) -> Option> { get_default(self, key) } #[cfg(test)] fn get<'v>(&'v self, key: Key) -> Option>; /// Count the number of key-value pairs that can be visited. /// /// # Implementation notes /// /// A source that knows the number of key-value pairs upfront may provide a more /// efficient implementation. /// /// A subsequent call to `visit` should yield the same number of key-value pairs /// to the visitor, unless that visitor fails part way through. #[cfg(not(test))] fn count(&self) -> usize { count_default(self) } #[cfg(test)] fn count(&self) -> usize; } /// The default implemention of `Source::get` pub(crate) fn get_default<'v>(source: &'v (impl Source + ?Sized), key: Key) -> Option> { struct Get<'k, 'v> { key: Key<'k>, found: Option>, } impl<'k, 'kvs> Visitor<'kvs> for Get<'k, 'kvs> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { if self.key == key { self.found = Some(value); } Ok(()) } } let mut get = Get { key, found: None }; let _ = source.visit(&mut get); get.found } /// The default implementation of `Source::count`. pub(crate) fn count_default(source: impl Source) -> usize { struct Count(usize); impl<'kvs> Visitor<'kvs> for Count { fn visit_pair(&mut self, _: Key<'kvs>, _: Value<'kvs>) -> Result<(), Error> { self.0 += 1; Ok(()) } } let mut count = Count(0); let _ = source.visit(&mut count); count.0 } impl<'a, T> Source for &'a T where T: Source + ?Sized, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { Source::visit(&**self, visitor) } fn get<'v>(&'v self, key: Key) -> Option> { Source::get(&**self, key) } fn count(&self) -> usize { Source::count(&**self) } } impl Source for (K, V) where K: ToKey, V: ToValue, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { visitor.visit_pair(self.0.to_key(), self.1.to_value()) } fn get<'v>(&'v self, key: Key) -> Option> { if self.0.to_key() == key { Some(self.1.to_value()) } else { None } } fn count(&self) -> usize { 1 } } impl Source for [S] where S: Source, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { for source in self { source.visit(visitor)?; } Ok(()) } fn get<'v>(&'v self, key: Key) -> Option> { for source in self { if let Some(found) = source.get(key.clone()) { return Some(found); } } None } fn count(&self) -> usize { self.len() } } impl Source for Option where S: Source, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { if let Some(ref source) = *self { source.visit(visitor)?; } Ok(()) } fn get<'v>(&'v self, key: Key) -> Option> { self.as_ref().and_then(|s| s.get(key)) } fn count(&self) -> usize { self.as_ref().map(Source::count).unwrap_or(0) } } /// A visitor for the key-value pairs in a [`Source`](trait.Source.html). pub trait Visitor<'kvs> { /// Visit a key-value pair. fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error>; } impl<'a, 'kvs, T> Visitor<'kvs> for &'a mut T where T: Visitor<'kvs> + ?Sized, { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { (**self).visit_pair(key, value) } } impl<'a, 'b: 'a, 'kvs> Visitor<'kvs> for fmt::DebugMap<'a, 'b> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.entry(&key, &value); Ok(()) } } impl<'a, 'b: 'a, 'kvs> Visitor<'kvs> for fmt::DebugList<'a, 'b> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.entry(&(key, value)); Ok(()) } } impl<'a, 'b: 'a, 'kvs> Visitor<'kvs> for fmt::DebugSet<'a, 'b> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.entry(&(key, value)); Ok(()) } } impl<'a, 'b: 'a, 'kvs> Visitor<'kvs> for fmt::DebugTuple<'a, 'b> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.field(&key); self.field(&value); Ok(()) } } #[cfg(feature = "std")] mod std_support { use super::*; use std::borrow::Borrow; use std::collections::{BTreeMap, HashMap}; use std::hash::{BuildHasher, Hash}; impl Source for Box where S: Source + ?Sized, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { Source::visit(&**self, visitor) } fn get<'v>(&'v self, key: Key) -> Option> { Source::get(&**self, key) } fn count(&self) -> usize { Source::count(&**self) } } impl Source for Vec where S: Source, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { Source::visit(&**self, visitor) } fn get<'v>(&'v self, key: Key) -> Option> { Source::get(&**self, key) } fn count(&self) -> usize { Source::count(&**self) } } impl<'kvs, V> Visitor<'kvs> for Box where V: Visitor<'kvs> + ?Sized, { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { (**self).visit_pair(key, value) } } impl Source for HashMap where K: ToKey + Borrow + Eq + Hash, V: ToValue, S: BuildHasher, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { for (key, value) in self { visitor.visit_pair(key.to_key(), value.to_value())?; } Ok(()) } fn get<'v>(&'v self, key: Key) -> Option> { HashMap::get(self, key.as_str()).map(|v| v.to_value()) } fn count(&self) -> usize { self.len() } } impl Source for BTreeMap where K: ToKey + Borrow + Ord, V: ToValue, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { for (key, value) in self { visitor.visit_pair(key.to_key(), value.to_value())?; } Ok(()) } fn get<'v>(&'v self, key: Key) -> Option> { BTreeMap::get(self, key.as_str()).map(|v| v.to_value()) } fn count(&self) -> usize { self.len() } } #[cfg(test)] mod tests { use super::*; use kv::value::tests::Token; use std::collections::{BTreeMap, HashMap}; #[test] fn count() { assert_eq!(1, Source::count(&Box::new(("a", 1)))); assert_eq!(2, Source::count(&vec![("a", 1), ("b", 2)])); } #[test] fn get() { let source = vec![("a", 1), ("b", 2), ("a", 1)]; assert_eq!( Token::I64(1), Source::get(&source, Key::from_str("a")).unwrap().to_token() ); let source = Box::new(Option::None::<(&str, i32)>); assert!(Source::get(&source, Key::from_str("a")).is_none()); } #[test] fn hash_map() { let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); assert_eq!(2, Source::count(&map)); assert_eq!( Token::I64(1), Source::get(&map, Key::from_str("a")).unwrap().to_token() ); } #[test] fn btree_map() { let mut map = BTreeMap::new(); map.insert("a", 1); map.insert("b", 2); assert_eq!(2, Source::count(&map)); assert_eq!( Token::I64(1), Source::get(&map, Key::from_str("a")).unwrap().to_token() ); } } } /// The result of calling `Source::as_map`. pub struct AsMap(S); /// Visit this source as a map. pub fn as_map(source: S) -> AsMap where S: Source, { AsMap(source) } impl Source for AsMap where S: Source, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { self.0.visit(visitor) } fn get<'v>(&'v self, key: Key) -> Option> { self.0.get(key) } fn count(&self) -> usize { self.0.count() } } impl fmt::Debug for AsMap where S: Source, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut f = f.debug_map(); self.0.visit(&mut f).map_err(|_| fmt::Error)?; f.finish() } } /// The result of calling `Source::as_list` pub struct AsList(S); /// Visit this source as a list. pub fn as_list(source: S) -> AsList where S: Source, { AsList(source) } impl Source for AsList where S: Source, { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { self.0.visit(visitor) } fn get<'v>(&'v self, key: Key) -> Option> { self.0.get(key) } fn count(&self) -> usize { self.0.count() } } impl fmt::Debug for AsList where S: Source, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut f = f.debug_list(); self.0.visit(&mut f).map_err(|_| fmt::Error)?; f.finish() } } #[cfg(feature = "kv_unstable_sval")] mod sval_support { use super::*; impl self::sval::Value for AsMap where S: Source, { fn stream<'sval, SV: self::sval::Stream<'sval> + ?Sized>( &'sval self, stream: &mut SV, ) -> self::sval::Result { struct StreamVisitor<'a, V: ?Sized>(&'a mut V); impl<'a, 'kvs, V: self::sval::Stream<'kvs> + ?Sized> Visitor<'kvs> for StreamVisitor<'a, V> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.0 .map_key_begin() .map_err(|_| Error::msg("failed to stream map key"))?; sval_ref::stream_ref(self.0, key) .map_err(|_| Error::msg("failed to stream map key"))?; self.0 .map_key_end() .map_err(|_| Error::msg("failed to stream map key"))?; self.0 .map_value_begin() .map_err(|_| Error::msg("failed to stream map value"))?; sval_ref::stream_ref(self.0, value) .map_err(|_| Error::msg("failed to stream map value"))?; self.0 .map_value_end() .map_err(|_| Error::msg("failed to stream map value"))?; Ok(()) } } stream .map_begin(Some(self.count())) .map_err(|_| self::sval::Error::new())?; self.visit(&mut StreamVisitor(stream)) .map_err(|_| self::sval::Error::new())?; stream.map_end().map_err(|_| self::sval::Error::new()) } } impl self::sval::Value for AsList where S: Source, { fn stream<'sval, SV: self::sval::Stream<'sval> + ?Sized>( &'sval self, stream: &mut SV, ) -> self::sval::Result { struct StreamVisitor<'a, V: ?Sized>(&'a mut V); impl<'a, 'kvs, V: self::sval::Stream<'kvs> + ?Sized> Visitor<'kvs> for StreamVisitor<'a, V> { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.0 .seq_value_begin() .map_err(|_| Error::msg("failed to stream seq value"))?; self::sval_ref::stream_ref(self.0, (key, value)) .map_err(|_| Error::msg("failed to stream seq value"))?; self.0 .seq_value_end() .map_err(|_| Error::msg("failed to stream seq value"))?; Ok(()) } } stream .seq_begin(Some(self.count())) .map_err(|_| self::sval::Error::new())?; self.visit(&mut StreamVisitor(stream)) .map_err(|_| self::sval::Error::new())?; stream.seq_end().map_err(|_| self::sval::Error::new()) } } #[cfg(test)] mod tests { extern crate sval_derive; use super::*; use self::sval_derive::Value; use crate::kv::source; #[test] fn derive_stream() { #[derive(Value)] pub struct MyRecordAsMap<'a> { msg: &'a str, kvs: source::AsMap<&'a dyn Source>, } #[derive(Value)] pub struct MyRecordAsList<'a> { msg: &'a str, kvs: source::AsList<&'a dyn Source>, } } } } #[cfg(feature = "kv_unstable_serde")] pub mod as_map { //! `serde` adapters for serializing a `Source` as a map. use super::*; use self::serde::{Serialize, Serializer}; /// Serialize a `Source` as a map. pub fn serialize(source: &T, serializer: S) -> Result where T: Source, S: Serializer, { as_map(source).serialize(serializer) } } #[cfg(feature = "kv_unstable_serde")] pub mod as_list { //! `serde` adapters for serializing a `Source` as a list. use super::*; use self::serde::{Serialize, Serializer}; /// Serialize a `Source` as a list. pub fn serialize(source: &T, serializer: S) -> Result where T: Source, S: Serializer, { as_list(source).serialize(serializer) } } #[cfg(feature = "kv_unstable_serde")] mod serde_support { use super::*; use self::serde::ser::{Error as SerError, Serialize, SerializeMap, SerializeSeq, Serializer}; impl Serialize for AsMap where T: Source, { fn serialize(&self, serializer: S) -> Result where S: Serializer, { struct SerializerVisitor<'a, S>(&'a mut S); impl<'a, 'kvs, S> Visitor<'kvs> for SerializerVisitor<'a, S> where S: SerializeMap, { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.0 .serialize_entry(&key, &value) .map_err(|_| Error::msg("failed to serialize map entry"))?; Ok(()) } } let mut map = serializer.serialize_map(Some(self.count()))?; self.visit(&mut SerializerVisitor(&mut map)) .map_err(|_| S::Error::custom("failed to visit key-values"))?; map.end() } } impl Serialize for AsList where T: Source, { fn serialize(&self, serializer: S) -> Result where S: Serializer, { struct SerializerVisitor<'a, S>(&'a mut S); impl<'a, 'kvs, S> Visitor<'kvs> for SerializerVisitor<'a, S> where S: SerializeSeq, { fn visit_pair(&mut self, key: Key<'kvs>, value: Value<'kvs>) -> Result<(), Error> { self.0 .serialize_element(&(key, value)) .map_err(|_| Error::msg("failed to serialize seq entry"))?; Ok(()) } } let mut seq = serializer.serialize_seq(Some(self.count()))?; self.visit(&mut SerializerVisitor(&mut seq)) .map_err(|_| S::Error::custom("failed to visit seq"))?; seq.end() } } #[cfg(test)] mod tests { use super::*; use self::serde::Serialize; use crate::kv::source; #[test] fn derive_serialize() { #[derive(Serialize)] pub struct MyRecordAsMap<'a> { msg: &'a str, #[serde(flatten)] #[serde(with = "source::as_map")] kvs: &'a dyn Source, } #[derive(Serialize)] pub struct MyRecordAsList<'a> { msg: &'a str, #[serde(flatten)] #[serde(with = "source::as_list")] kvs: &'a dyn Source, } } } } #[cfg(test)] mod tests { use super::*; use kv::value::tests::Token; #[test] fn source_is_object_safe() { fn _check(_: &dyn Source) {} } #[test] fn visitor_is_object_safe() { fn _check(_: &dyn Visitor) {} } #[test] fn count() { struct OnePair { key: &'static str, value: i32, } impl Source for OnePair { fn visit<'kvs>(&'kvs self, visitor: &mut dyn Visitor<'kvs>) -> Result<(), Error> { visitor.visit_pair(self.key.to_key(), self.value.to_value()) } fn get<'v>(&'v self, key: Key) -> Option> { get_default(self, key) } fn count(&self) -> usize { count_default(self) } } assert_eq!(1, Source::count(&("a", 1))); assert_eq!(2, Source::count(&[("a", 1), ("b", 2)] as &[_])); assert_eq!(0, Source::count(&Option::None::<(&str, i32)>)); assert_eq!(1, Source::count(&OnePair { key: "a", value: 1 })); } #[test] fn get() { let source = &[("a", 1), ("b", 2), ("a", 1)] as &[_]; assert_eq!( Token::I64(1), Source::get(source, Key::from_str("a")).unwrap().to_token() ); assert_eq!( Token::I64(2), Source::get(source, Key::from_str("b")).unwrap().to_token() ); assert!(Source::get(&source, Key::from_str("c")).is_none()); let source = Option::None::<(&str, i32)>; assert!(Source::get(&source, Key::from_str("a")).is_none()); } #[test] fn as_map() { let _ = crate::kv::source::as_map(("a", 1)); let _ = crate::kv::source::as_map(&("a", 1) as &dyn Source); } #[test] fn as_list() { let _ = crate::kv::source::as_list(("a", 1)); let _ = crate::kv::source::as_list(&("a", 1) as &dyn Source); } } log-0.4.20/src/kv/value.rs000064400000000000000000000665651046102023000134030ustar 00000000000000//! Structured values. use std::fmt; extern crate value_bag; #[cfg(feature = "kv_unstable_sval")] extern crate sval; #[cfg(feature = "kv_unstable_sval")] extern crate sval_ref; #[cfg(feature = "kv_unstable_serde")] extern crate serde; use self::value_bag::ValueBag; pub use kv::Error; /// A type that can be converted into a [`Value`](struct.Value.html). pub trait ToValue { /// Perform the conversion. fn to_value(&self) -> Value; } impl<'a, T> ToValue for &'a T where T: ToValue + ?Sized, { fn to_value(&self) -> Value { (**self).to_value() } } impl<'v> ToValue for Value<'v> { fn to_value(&self) -> Value { Value { inner: self.inner.clone(), } } } /// Get a value from a type implementing `std::fmt::Debug`. #[macro_export] macro_rules! as_debug { ($capture:expr) => { $crate::kv::Value::from_debug(&$capture) }; } /// Get a value from a type implementing `std::fmt::Display`. #[macro_export] macro_rules! as_display { ($capture:expr) => { $crate::kv::Value::from_display(&$capture) }; } /// Get a value from an error. #[cfg(feature = "kv_unstable_std")] #[macro_export] macro_rules! as_error { ($capture:expr) => { $crate::kv::Value::from_dyn_error(&$capture) }; } #[cfg(feature = "kv_unstable_serde")] /// Get a value from a type implementing `serde::Serialize`. #[macro_export] macro_rules! as_serde { ($capture:expr) => { $crate::kv::Value::from_serde(&$capture) }; } /// Get a value from a type implementing `sval::Value`. #[cfg(feature = "kv_unstable_sval")] #[macro_export] macro_rules! as_sval { ($capture:expr) => { $crate::kv::Value::from_sval(&$capture) }; } /// A value in a structured key-value pair. /// /// # Capturing values /// /// There are a few ways to capture a value: /// /// - Using the `Value::capture_*` methods. /// - Using the `Value::from_*` methods. /// - Using the `ToValue` trait. /// - Using the standard `From` trait. /// /// ## Using the `Value::capture_*` methods /// /// `Value` offers a few constructor methods that capture values of different kinds. /// These methods require a `T: 'static` to support downcasting. /// /// ``` /// use log::kv::Value; /// /// let value = Value::capture_debug(&42i32); /// /// assert_eq!(Some(42), value.to_i64()); /// ``` /// /// ## Using the `Value::from_*` methods /// /// `Value` offers a few constructor methods that capture values of different kinds. /// These methods don't require `T: 'static`, but can't support downcasting. /// /// ``` /// use log::kv::Value; /// /// let value = Value::from_debug(&42i32); /// /// assert_eq!(None, value.to_i64()); /// ``` /// /// ## Using the `ToValue` trait /// /// The `ToValue` trait can be used to capture values generically. /// It's the bound used by `Source`. /// /// ``` /// # use log::kv::ToValue; /// let value = 42i32.to_value(); /// /// assert_eq!(Some(42), value.to_i64()); /// ``` /// /// ``` /// # use std::fmt::Debug; /// use log::kv::ToValue; /// /// let value = (&42i32 as &dyn Debug).to_value(); /// /// assert_eq!(None, value.to_i64()); /// ``` /// /// ## Using the standard `From` trait /// /// Standard types that implement `ToValue` also implement `From`. /// /// ``` /// use log::kv::Value; /// /// let value = Value::from(42i32); /// /// assert_eq!(Some(42), value.to_i64()); /// ``` pub struct Value<'v> { inner: ValueBag<'v>, } impl<'v> Value<'v> { /// Get a value from a type implementing `ToValue`. pub fn from_any(value: &'v T) -> Self where T: ToValue, { value.to_value() } /// Get a value from a type implementing `std::fmt::Debug`. pub fn capture_debug(value: &'v T) -> Self where T: fmt::Debug + 'static, { Value { inner: ValueBag::capture_debug(value), } } /// Get a value from a type implementing `std::fmt::Display`. pub fn capture_display(value: &'v T) -> Self where T: fmt::Display + 'static, { Value { inner: ValueBag::capture_display(value), } } /// Get a value from an error. #[cfg(feature = "kv_unstable_std")] pub fn capture_error(err: &'v T) -> Self where T: std::error::Error + 'static, { Value { inner: ValueBag::capture_error(err), } } #[cfg(feature = "kv_unstable_serde")] /// Get a value from a type implementing `serde::Serialize`. pub fn capture_serde(value: &'v T) -> Self where T: self::serde::Serialize + 'static, { Value { inner: ValueBag::capture_serde1(value), } } /// Get a value from a type implementing `sval::Value`. #[cfg(feature = "kv_unstable_sval")] pub fn capture_sval(value: &'v T) -> Self where T: self::sval::Value + 'static, { Value { inner: ValueBag::capture_sval2(value), } } /// Get a value from a type implementing `std::fmt::Debug`. pub fn from_debug(value: &'v T) -> Self where T: fmt::Debug, { Value { inner: ValueBag::from_debug(value), } } /// Get a value from a type implementing `std::fmt::Display`. pub fn from_display(value: &'v T) -> Self where T: fmt::Display, { Value { inner: ValueBag::from_display(value), } } /// Get a value from a type implementing `serde::Serialize`. #[cfg(feature = "kv_unstable_serde")] pub fn from_serde(value: &'v T) -> Self where T: self::serde::Serialize, { Value { inner: ValueBag::from_serde1(value), } } /// Get a value from a type implementing `sval::Value`. #[cfg(feature = "kv_unstable_sval")] pub fn from_sval(value: &'v T) -> Self where T: self::sval::Value, { Value { inner: ValueBag::from_sval2(value), } } /// Get a value from a dynamic `std::fmt::Debug`. pub fn from_dyn_debug(value: &'v dyn fmt::Debug) -> Self { Value { inner: ValueBag::from_dyn_debug(value), } } /// Get a value from a dynamic `std::fmt::Display`. pub fn from_dyn_display(value: &'v dyn fmt::Display) -> Self { Value { inner: ValueBag::from_dyn_display(value), } } /// Get a value from a dynamic error. #[cfg(feature = "kv_unstable_std")] pub fn from_dyn_error(err: &'v (dyn std::error::Error + 'static)) -> Self { Value { inner: ValueBag::from_dyn_error(err), } } /// Get a value from an internal primitive. fn from_value_bag(value: T) -> Self where T: Into>, { Value { inner: value.into(), } } /// Check whether this value can be downcast to `T`. pub fn is(&self) -> bool { self.inner.is::() } /// Try downcast this value to `T`. pub fn downcast_ref(&self) -> Option<&T> { self.inner.downcast_ref::() } /// Inspect this value using a simple visitor. pub fn visit(&self, visitor: impl Visit<'v>) -> Result<(), Error> { struct Visitor(V); impl<'v, V> value_bag::visit::Visit<'v> for Visitor where V: Visit<'v>, { fn visit_any(&mut self, value: ValueBag) -> Result<(), value_bag::Error> { self.0 .visit_any(Value { inner: value }) .map_err(Error::into_value) } fn visit_u64(&mut self, value: u64) -> Result<(), value_bag::Error> { self.0.visit_u64(value).map_err(Error::into_value) } fn visit_i64(&mut self, value: i64) -> Result<(), value_bag::Error> { self.0.visit_i64(value).map_err(Error::into_value) } fn visit_u128(&mut self, value: u128) -> Result<(), value_bag::Error> { self.0.visit_u128(value).map_err(Error::into_value) } fn visit_i128(&mut self, value: i128) -> Result<(), value_bag::Error> { self.0.visit_i128(value).map_err(Error::into_value) } fn visit_f64(&mut self, value: f64) -> Result<(), value_bag::Error> { self.0.visit_f64(value).map_err(Error::into_value) } fn visit_bool(&mut self, value: bool) -> Result<(), value_bag::Error> { self.0.visit_bool(value).map_err(Error::into_value) } fn visit_str(&mut self, value: &str) -> Result<(), value_bag::Error> { self.0.visit_str(value).map_err(Error::into_value) } fn visit_borrowed_str(&mut self, value: &'v str) -> Result<(), value_bag::Error> { self.0.visit_borrowed_str(value).map_err(Error::into_value) } fn visit_char(&mut self, value: char) -> Result<(), value_bag::Error> { self.0.visit_char(value).map_err(Error::into_value) } #[cfg(feature = "kv_unstable_std")] fn visit_error( &mut self, err: &(dyn std::error::Error + 'static), ) -> Result<(), value_bag::Error> { self.0.visit_error(err).map_err(Error::into_value) } #[cfg(feature = "kv_unstable_std")] fn visit_borrowed_error( &mut self, err: &'v (dyn std::error::Error + 'static), ) -> Result<(), value_bag::Error> { self.0.visit_borrowed_error(err).map_err(Error::into_value) } } self.inner .visit(&mut Visitor(visitor)) .map_err(Error::from_value) } } impl<'v> fmt::Debug for Value<'v> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self.inner, f) } } impl<'v> fmt::Display for Value<'v> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(&self.inner, f) } } impl ToValue for dyn fmt::Debug { fn to_value(&self) -> Value { Value::from_dyn_debug(self) } } impl ToValue for dyn fmt::Display { fn to_value(&self) -> Value { Value::from_dyn_display(self) } } #[cfg(feature = "kv_unstable_std")] impl ToValue for dyn std::error::Error + 'static { fn to_value(&self) -> Value { Value::from_dyn_error(self) } } #[cfg(feature = "kv_unstable_serde")] impl<'v> self::serde::Serialize for Value<'v> { fn serialize(&self, s: S) -> Result where S: self::serde::Serializer, { self.inner.serialize(s) } } #[cfg(feature = "kv_unstable_sval")] impl<'v> self::sval::Value for Value<'v> { fn stream<'sval, S: self::sval::Stream<'sval> + ?Sized>( &'sval self, stream: &mut S, ) -> self::sval::Result { self::sval::Value::stream(&self.inner, stream) } } #[cfg(feature = "kv_unstable_sval")] impl<'v> self::sval_ref::ValueRef<'v> for Value<'v> { fn stream_ref + ?Sized>(&self, stream: &mut S) -> self::sval::Result { self::sval_ref::ValueRef::stream_ref(&self.inner, stream) } } impl ToValue for str { fn to_value(&self) -> Value { Value::from(self) } } impl ToValue for u128 { fn to_value(&self) -> Value { Value::from(self) } } impl ToValue for i128 { fn to_value(&self) -> Value { Value::from(self) } } impl ToValue for std::num::NonZeroU128 { fn to_value(&self) -> Value { Value::from(self) } } impl ToValue for std::num::NonZeroI128 { fn to_value(&self) -> Value { Value::from(self) } } impl<'v> From<&'v str> for Value<'v> { fn from(value: &'v str) -> Self { Value::from_value_bag(value) } } impl<'v> From<&'v u128> for Value<'v> { fn from(value: &'v u128) -> Self { Value::from_value_bag(value) } } impl<'v> From<&'v i128> for Value<'v> { fn from(value: &'v i128) -> Self { Value::from_value_bag(value) } } impl<'v> From<&'v std::num::NonZeroU128> for Value<'v> { fn from(v: &'v std::num::NonZeroU128) -> Value<'v> { // SAFETY: `NonZeroU128` and `u128` have the same ABI Value::from_value_bag(unsafe { std::mem::transmute::<&std::num::NonZeroU128, &u128>(v) }) } } impl<'v> From<&'v std::num::NonZeroI128> for Value<'v> { fn from(v: &'v std::num::NonZeroI128) -> Value<'v> { // SAFETY: `NonZeroI128` and `i128` have the same ABI Value::from_value_bag(unsafe { std::mem::transmute::<&std::num::NonZeroI128, &i128>(v) }) } } impl ToValue for () { fn to_value(&self) -> Value { Value::from_value_bag(()) } } impl ToValue for Option where T: ToValue, { fn to_value(&self) -> Value { match *self { Some(ref value) => value.to_value(), None => Value::from_value_bag(()), } } } macro_rules! impl_to_value_primitive { ($($into_ty:ty,)*) => { $( impl ToValue for $into_ty { fn to_value(&self) -> Value { Value::from(*self) } } impl<'v> From<$into_ty> for Value<'v> { fn from(value: $into_ty) -> Self { Value::from_value_bag(value) } } )* }; } macro_rules! impl_to_value_nonzero_primitive { ($($into_ty:ident,)*) => { $( impl ToValue for std::num::$into_ty { fn to_value(&self) -> Value { Value::from(self.get()) } } impl<'v> From for Value<'v> { fn from(value: std::num::$into_ty) -> Self { Value::from(value.get()) } } )* }; } macro_rules! impl_value_to_primitive { ($(#[doc = $doc:tt] $into_name:ident -> $into_ty:ty,)*) => { impl<'v> Value<'v> { $( #[doc = $doc] pub fn $into_name(&self) -> Option<$into_ty> { self.inner.$into_name() } )* } } } impl_to_value_primitive![usize, u8, u16, u32, u64, isize, i8, i16, i32, i64, f32, f64, char, bool,]; #[rustfmt::skip] impl_to_value_nonzero_primitive![ NonZeroUsize, NonZeroU8, NonZeroU16, NonZeroU32, NonZeroU64, NonZeroIsize, NonZeroI8, NonZeroI16, NonZeroI32, NonZeroI64, ]; impl_value_to_primitive![ #[doc = "Try convert this value into a `u64`."] to_u64 -> u64, #[doc = "Try convert this value into a `i64`."] to_i64 -> i64, #[doc = "Try convert this value into a `u128`."] to_u128 -> u128, #[doc = "Try convert this value into a `i128`."] to_i128 -> i128, #[doc = "Try convert this value into a `f64`."] to_f64 -> f64, #[doc = "Try convert this value into a `char`."] to_char -> char, #[doc = "Try convert this value into a `bool`."] to_bool -> bool, ]; impl<'v> Value<'v> { /// Try convert this value into an error. #[cfg(feature = "kv_unstable_std")] pub fn to_borrowed_error(&self) -> Option<&(dyn std::error::Error + 'static)> { self.inner.to_borrowed_error() } /// Try convert this value into a borrowed string. pub fn to_borrowed_str(&self) -> Option<&str> { self.inner.to_borrowed_str() } } #[cfg(feature = "kv_unstable_std")] mod std_support { use super::*; use std::borrow::Cow; impl ToValue for Box where T: ToValue + ?Sized, { fn to_value(&self) -> Value { (**self).to_value() } } impl ToValue for String { fn to_value(&self) -> Value { Value::from(&**self) } } impl<'v> ToValue for Cow<'v, str> { fn to_value(&self) -> Value { Value::from(&**self) } } impl<'v> Value<'v> { /// Try convert this value into a string. pub fn to_str(&self) -> Option> { self.inner.to_str() } } impl<'v> From<&'v String> for Value<'v> { fn from(v: &'v String) -> Self { Value::from(&**v) } } } /// A visitor for a `Value`. pub trait Visit<'v> { /// Visit a `Value`. /// /// This is the only required method on `Visit` and acts as a fallback for any /// more specific methods that aren't overridden. /// The `Value` may be formatted using its `fmt::Debug` or `fmt::Display` implementation, /// or serialized using its `sval::Value` or `serde::Serialize` implementation. fn visit_any(&mut self, value: Value) -> Result<(), Error>; /// Visit an unsigned integer. fn visit_u64(&mut self, value: u64) -> Result<(), Error> { self.visit_any(value.into()) } /// Visit a signed integer. fn visit_i64(&mut self, value: i64) -> Result<(), Error> { self.visit_any(value.into()) } /// Visit a big unsigned integer. fn visit_u128(&mut self, value: u128) -> Result<(), Error> { self.visit_any((&value).into()) } /// Visit a big signed integer. fn visit_i128(&mut self, value: i128) -> Result<(), Error> { self.visit_any((&value).into()) } /// Visit a floating point. fn visit_f64(&mut self, value: f64) -> Result<(), Error> { self.visit_any(value.into()) } /// Visit a boolean. fn visit_bool(&mut self, value: bool) -> Result<(), Error> { self.visit_any(value.into()) } /// Visit a string. fn visit_str(&mut self, value: &str) -> Result<(), Error> { self.visit_any(value.into()) } /// Visit a string. fn visit_borrowed_str(&mut self, value: &'v str) -> Result<(), Error> { self.visit_str(value) } /// Visit a Unicode character. fn visit_char(&mut self, value: char) -> Result<(), Error> { let mut b = [0; 4]; self.visit_str(&*value.encode_utf8(&mut b)) } /// Visit an error. #[cfg(feature = "kv_unstable_std")] fn visit_error(&mut self, err: &(dyn std::error::Error + 'static)) -> Result<(), Error> { self.visit_any(Value::from_dyn_error(err)) } /// Visit an error. #[cfg(feature = "kv_unstable_std")] fn visit_borrowed_error( &mut self, err: &'v (dyn std::error::Error + 'static), ) -> Result<(), Error> { self.visit_any(Value::from_dyn_error(err)) } } impl<'a, 'v, T: ?Sized> Visit<'v> for &'a mut T where T: Visit<'v>, { fn visit_any(&mut self, value: Value) -> Result<(), Error> { (**self).visit_any(value) } fn visit_u64(&mut self, value: u64) -> Result<(), Error> { (**self).visit_u64(value) } fn visit_i64(&mut self, value: i64) -> Result<(), Error> { (**self).visit_i64(value) } fn visit_u128(&mut self, value: u128) -> Result<(), Error> { (**self).visit_u128(value) } fn visit_i128(&mut self, value: i128) -> Result<(), Error> { (**self).visit_i128(value) } fn visit_f64(&mut self, value: f64) -> Result<(), Error> { (**self).visit_f64(value) } fn visit_bool(&mut self, value: bool) -> Result<(), Error> { (**self).visit_bool(value) } fn visit_str(&mut self, value: &str) -> Result<(), Error> { (**self).visit_str(value) } fn visit_borrowed_str(&mut self, value: &'v str) -> Result<(), Error> { (**self).visit_borrowed_str(value) } fn visit_char(&mut self, value: char) -> Result<(), Error> { (**self).visit_char(value) } #[cfg(feature = "kv_unstable_std")] fn visit_error(&mut self, err: &(dyn std::error::Error + 'static)) -> Result<(), Error> { (**self).visit_error(err) } #[cfg(feature = "kv_unstable_std")] fn visit_borrowed_error( &mut self, err: &'v (dyn std::error::Error + 'static), ) -> Result<(), Error> { (**self).visit_borrowed_error(err) } } #[cfg(test)] pub(crate) mod tests { use super::*; pub(crate) use super::value_bag::test::TestToken as Token; impl<'v> Value<'v> { pub(crate) fn to_token(&self) -> Token { self.inner.to_test_token() } } fn unsigned() -> impl Iterator> { vec![ Value::from(8u8), Value::from(16u16), Value::from(32u32), Value::from(64u64), Value::from(1usize), Value::from(std::num::NonZeroU8::new(8).unwrap()), Value::from(std::num::NonZeroU16::new(16).unwrap()), Value::from(std::num::NonZeroU32::new(32).unwrap()), Value::from(std::num::NonZeroU64::new(64).unwrap()), Value::from(std::num::NonZeroUsize::new(1).unwrap()), ] .into_iter() } fn signed() -> impl Iterator> { vec![ Value::from(-8i8), Value::from(-16i16), Value::from(-32i32), Value::from(-64i64), Value::from(-1isize), Value::from(std::num::NonZeroI8::new(-8).unwrap()), Value::from(std::num::NonZeroI16::new(-16).unwrap()), Value::from(std::num::NonZeroI32::new(-32).unwrap()), Value::from(std::num::NonZeroI64::new(-64).unwrap()), Value::from(std::num::NonZeroIsize::new(-1).unwrap()), ] .into_iter() } fn float() -> impl Iterator> { vec![Value::from(32.32f32), Value::from(64.64f64)].into_iter() } fn bool() -> impl Iterator> { vec![Value::from(true), Value::from(false)].into_iter() } fn str() -> impl Iterator> { vec![Value::from("a string"), Value::from("a loong string")].into_iter() } fn char() -> impl Iterator> { vec![Value::from('a'), Value::from('â›°')].into_iter() } #[test] fn test_capture_fmt() { assert_eq!(Some(42u64), Value::capture_display(&42).to_u64()); assert_eq!(Some(42u64), Value::capture_debug(&42).to_u64()); assert!(Value::from_display(&42).to_u64().is_none()); assert!(Value::from_debug(&42).to_u64().is_none()); } #[cfg(feature = "kv_unstable_std")] #[test] fn test_capture_error() { let err = std::io::Error::from(std::io::ErrorKind::Other); assert!(Value::capture_error(&err).to_borrowed_error().is_some()); assert!(Value::from_dyn_error(&err).to_borrowed_error().is_some()); } #[cfg(feature = "kv_unstable_serde")] #[test] fn test_capture_serde() { assert_eq!(Some(42u64), Value::capture_serde(&42).to_u64()); assert_eq!(Some(42u64), Value::from_serde(&42).to_u64()); } #[cfg(feature = "kv_unstable_sval")] #[test] fn test_capture_sval() { assert_eq!(Some(42u64), Value::capture_sval(&42).to_u64()); assert_eq!(Some(42u64), Value::from_sval(&42).to_u64()); } #[test] fn test_to_value_display() { assert_eq!(42u64.to_value().to_string(), "42"); assert_eq!(42i64.to_value().to_string(), "42"); assert_eq!(42.01f64.to_value().to_string(), "42.01"); assert_eq!(true.to_value().to_string(), "true"); assert_eq!('a'.to_value().to_string(), "a"); assert_eq!("a loong string".to_value().to_string(), "a loong string"); assert_eq!(Some(true).to_value().to_string(), "true"); assert_eq!(().to_value().to_string(), "None"); assert_eq!(Option::None::.to_value().to_string(), "None"); } #[test] fn test_to_value_structured() { assert_eq!(42u64.to_value().to_token(), Token::U64(42)); assert_eq!(42i64.to_value().to_token(), Token::I64(42)); assert_eq!(42.01f64.to_value().to_token(), Token::F64(42.01)); assert_eq!(true.to_value().to_token(), Token::Bool(true)); assert_eq!('a'.to_value().to_token(), Token::Char('a')); assert_eq!( "a loong string".to_value().to_token(), Token::Str("a loong string".into()) ); assert_eq!(Some(true).to_value().to_token(), Token::Bool(true)); assert_eq!(().to_value().to_token(), Token::None); assert_eq!(Option::None::.to_value().to_token(), Token::None); } #[test] fn test_to_number() { for v in unsigned() { assert!(v.to_u64().is_some()); assert!(v.to_i64().is_some()); } for v in signed() { assert!(v.to_i64().is_some()); } for v in unsigned().chain(signed()).chain(float()) { assert!(v.to_f64().is_some()); } for v in bool().chain(str()).chain(char()) { assert!(v.to_u64().is_none()); assert!(v.to_i64().is_none()); assert!(v.to_f64().is_none()); } } #[test] fn test_to_str() { for v in str() { assert!(v.to_borrowed_str().is_some()); #[cfg(feature = "kv_unstable_std")] assert!(v.to_str().is_some()); } let short_lived = String::from("short lived"); let v = Value::from(&*short_lived); assert!(v.to_borrowed_str().is_some()); #[cfg(feature = "kv_unstable_std")] assert!(v.to_str().is_some()); for v in unsigned().chain(signed()).chain(float()).chain(bool()) { assert!(v.to_borrowed_str().is_none()); #[cfg(feature = "kv_unstable_std")] assert!(v.to_str().is_none()); } } #[test] fn test_to_bool() { for v in bool() { assert!(v.to_bool().is_some()); } for v in unsigned() .chain(signed()) .chain(float()) .chain(str()) .chain(char()) { assert!(v.to_bool().is_none()); } } #[test] fn test_to_char() { for v in char() { assert!(v.to_char().is_some()); } for v in unsigned() .chain(signed()) .chain(float()) .chain(str()) .chain(bool()) { assert!(v.to_char().is_none()); } } #[test] fn test_downcast_ref() { #[derive(Debug)] struct Foo(u64); let v = Value::capture_debug(&Foo(42)); assert!(v.is::()); assert_eq!(42u64, v.downcast_ref::().expect("invalid downcast").0); } #[test] fn test_visit_integer() { struct Extract(Option); impl<'v> Visit<'v> for Extract { fn visit_any(&mut self, value: Value) -> Result<(), Error> { unimplemented!("unexpected value: {:?}", value) } fn visit_u64(&mut self, value: u64) -> Result<(), Error> { self.0 = Some(value); Ok(()) } } let mut extract = Extract(None); Value::from(42u64).visit(&mut extract).unwrap(); assert_eq!(Some(42), extract.0); } #[test] fn test_visit_borrowed_str() { struct Extract<'v>(Option<&'v str>); impl<'v> Visit<'v> for Extract<'v> { fn visit_any(&mut self, value: Value) -> Result<(), Error> { unimplemented!("unexpected value: {:?}", value) } fn visit_borrowed_str(&mut self, value: &'v str) -> Result<(), Error> { self.0 = Some(value); Ok(()) } } let mut extract = Extract(None); let short_lived = String::from("A short-lived string"); Value::from(&*short_lived).visit(&mut extract).unwrap(); assert_eq!(Some("A short-lived string"), extract.0); } } log-0.4.20/src/lib.rs000064400000000000000000001562771046102023000124150ustar 00000000000000// Copyright 2015 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! A lightweight logging facade. //! //! The `log` crate 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. //! //! If no logging implementation is selected, the facade falls back to a "noop" //! implementation that ignores all log messages. The overhead in this case //! is very small - just an integer load, comparison and jump. //! //! A log request consists of a _target_, a _level_, and a _body_. A target is a //! string which defaults to the module path of the location of the log request, //! though that default may be overridden. Logger implementations typically use //! the target to filter requests based on some user configuration. //! //! # Usage //! //! The basic use of the log crate is through the five logging macros: [`error!`], //! [`warn!`], [`info!`], [`debug!`] and [`trace!`] //! where `error!` represents the highest-priority log messages //! and `trace!` the lowest. The log messages are filtered by configuring //! the log level to exclude messages with a lower priority. //! Each of these macros accept format strings similarly to [`println!`]. //! //! //! [`error!`]: ./macro.error.html //! [`warn!`]: ./macro.warn.html //! [`info!`]: ./macro.info.html //! [`debug!`]: ./macro.debug.html //! [`trace!`]: ./macro.trace.html //! [`println!`]: https://doc.rust-lang.org/stable/std/macro.println.html //! //! ## 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. //! //! ### Examples //! //! ```edition2018 //! # #[derive(Debug)] pub struct Yak(String); //! # impl Yak { fn shave(&mut self, _: u32) {} } //! # fn find_a_razor() -> Result { Ok(1) } //! use log::{info, warn}; //! //! pub fn shave_the_yak(yak: &mut Yak) { //! info!(target: "yak_events", "Commencing yak shaving for {:?}", yak); //! //! 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); //! } //! } //! } //! } //! # fn main() {} //! ``` //! //! ## In executables //! //! Executables should choose a logging implementation and initialize it early in the //! runtime of the program. Logging implementations will typically include a //! function to do this. Any log messages generated before //! the implementation is initialized will be ignored. //! //! The executable itself may use the `log` crate to log as well. //! //! ### Warning //! //! The logging system may only be initialized once. //! //! ## Structured logging //! //! If you enable the `kv_unstable` feature you can associate structured values //! with your log records. If we take the example from before, we can include //! some additional context besides what's in the formatted message: //! //! ```edition2018 //! # #[macro_use] extern crate serde; //! # #[derive(Debug, Serialize)] pub struct Yak(String); //! # impl Yak { fn shave(&mut self, _: u32) {} } //! # fn find_a_razor() -> Result { Ok(1) } //! # #[cfg(feature = "kv_unstable_serde")] //! # fn main() { //! use log::{info, warn, as_serde, as_error}; //! //! pub fn shave_the_yak(yak: &mut Yak) { //! info!(target: "yak_events", yak = as_serde!(yak); "Commencing yak shaving"); //! //! loop { //! match find_a_razor() { //! Ok(razor) => { //! info!(razor = razor; "Razor located"); //! yak.shave(razor); //! break; //! } //! Err(err) => { //! warn!(err = as_error!(err); "Unable to locate a razor, retrying"); //! } //! } //! } //! } //! # } //! # #[cfg(not(feature = "kv_unstable_serde"))] //! # fn main() {} //! ``` //! //! # Available logging implementations //! //! 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: //! //! * Simple minimal loggers: //! * [env_logger] //! * [simple_logger] //! * [simplelog] //! * [pretty_env_logger] //! * [stderrlog] //! * [flexi_logger] //! * [call_logger] //! * [structured-logger] //! * Complex configurable frameworks: //! * [log4rs] //! * [fern] //! * Adaptors for other facilities: //! * [syslog] //! * [slog-stdlog] //! * [systemd-journal-logger] //! * [android_log] //! * [win_dbg_logger] //! * [db_logger] //! * [log-to-defmt] //! * For WebAssembly binaries: //! * [console_log] //! * For dynamic libraries: //! * You may need to construct an FFI-safe wrapper over `log` to initialize in your libraries //! //! # Implementing a Logger //! //! Loggers implement the [`Log`] trait. Here's a very basic example that simply //! logs all messages at the [`Error`][level_link], [`Warn`][level_link] or //! [`Info`][level_link] levels to stdout: //! //! ```edition2018 //! use log::{Record, Level, Metadata}; //! //! struct SimpleLogger; //! //! impl log::Log for SimpleLogger { //! fn enabled(&self, metadata: &Metadata) -> bool { //! metadata.level() <= Level::Info //! } //! //! fn log(&self, record: &Record) { //! if self.enabled(record.metadata()) { //! println!("{} - {}", record.level(), record.args()); //! } //! } //! //! fn flush(&self) {} //! } //! //! # fn main() {} //! ``` //! //! Loggers are installed by calling the [`set_logger`] function. The maximum //! log level also needs to be adjusted via the [`set_max_level`] function. The //! logging facade uses this as an optimization to improve performance of log //! messages at levels that are disabled. It's important to set it, as it //! defaults to [`Off`][filter_link], so no log messages will ever be captured! //! In the case of our example logger, we'll want to set the maximum log level //! to [`Info`][filter_link], since we ignore any [`Debug`][level_link] or //! [`Trace`][level_link] level log messages. A logging implementation should //! provide a function that wraps a call to [`set_logger`] and //! [`set_max_level`], handling initialization of the logger: //! //! ```edition2018 //! # use log::{Level, Metadata}; //! # struct SimpleLogger; //! # impl log::Log for SimpleLogger { //! # fn enabled(&self, _: &Metadata) -> bool { false } //! # fn log(&self, _: &log::Record) {} //! # fn flush(&self) {} //! # } //! # fn main() {} //! use log::{SetLoggerError, LevelFilter}; //! //! static LOGGER: SimpleLogger = SimpleLogger; //! //! pub fn init() -> Result<(), SetLoggerError> { //! log::set_logger(&LOGGER) //! .map(|()| log::set_max_level(LevelFilter::Info)) //! } //! ``` //! //! Implementations that adjust their configurations at runtime should take care //! to adjust the maximum log level as well. //! //! # Use with `std` //! //! `set_logger` requires you to provide a `&'static Log`, which can be hard to //! obtain if your logger depends on some runtime configuration. The //! `set_boxed_logger` function is available with the `std` Cargo feature. It is //! identical to `set_logger` except that it takes a `Box` rather than a //! `&'static Log`: //! //! ```edition2018 //! # use log::{Level, LevelFilter, Log, SetLoggerError, Metadata}; //! # struct SimpleLogger; //! # impl log::Log for SimpleLogger { //! # fn enabled(&self, _: &Metadata) -> bool { false } //! # fn log(&self, _: &log::Record) {} //! # fn flush(&self) {} //! # } //! # fn main() {} //! # #[cfg(feature = "std")] //! pub fn init() -> Result<(), SetLoggerError> { //! log::set_boxed_logger(Box::new(SimpleLogger)) //! .map(|()| log::set_max_level(LevelFilter::Info)) //! } //! ``` //! //! # Compile time filters //! //! Log levels can be statically disabled at compile time via Cargo features. Log invocations at //! disabled levels will be skipped and will not even be present in the resulting binary. //! This level is configured separately for release and debug builds. The features are: //! //! * `max_level_off` //! * `max_level_error` //! * `max_level_warn` //! * `max_level_info` //! * `max_level_debug` //! * `max_level_trace` //! * `release_max_level_off` //! * `release_max_level_error` //! * `release_max_level_warn` //! * `release_max_level_info` //! * `release_max_level_debug` //! * `release_max_level_trace` //! //! These features control the value of the `STATIC_MAX_LEVEL` constant. The logging macros check //! this value before logging a message. By default, no levels are disabled. //! //! Libraries should avoid using the max level features because they're global and can't be changed //! once they're set. //! //! For example, a crate can disable trace level logs in debug builds and trace, debug, and info //! level logs in release builds with the following configuration: //! //! ```toml //! [dependencies] //! log = { version = "0.4", features = ["max_level_debug", "release_max_level_warn"] } //! ``` //! # Crate Feature Flags //! //! The following crate feature flags are available in addition to the filters. They are //! configured in your `Cargo.toml`. //! //! * `std` allows use of `std` crate instead of the default `core`. Enables using `std::error` and //! `set_boxed_logger` functionality. //! * `serde` enables support for serialization and deserialization of `Level` and `LevelFilter`. //! //! ```toml //! [dependencies] //! log = { version = "0.4", features = ["std", "serde"] } //! ``` //! //! # Version compatibility //! //! The 0.3 and 0.4 versions of the `log` crate are almost entirely compatible. Log messages //! made using `log` 0.3 will forward transparently to a logger implementation using `log` 0.4. Log //! messages made using `log` 0.4 will forward to a logger implementation using `log` 0.3, but the //! module path and file name information associated with the message will unfortunately be lost. //! //! [`Log`]: trait.Log.html //! [level_link]: enum.Level.html //! [filter_link]: enum.LevelFilter.html //! [`set_logger`]: fn.set_logger.html //! [`set_max_level`]: fn.set_max_level.html //! [`try_set_logger_raw`]: fn.try_set_logger_raw.html //! [`shutdown_logger_raw`]: fn.shutdown_logger_raw.html //! [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/ //! [call_logger]: https://docs.rs/call_logger/*/call_logger/ //! [syslog]: https://docs.rs/syslog/*/syslog/ //! [slog-stdlog]: https://docs.rs/slog-stdlog/*/slog_stdlog/ //! [log4rs]: https://docs.rs/log4rs/*/log4rs/ //! [fern]: https://docs.rs/fern/*/fern/ //! [systemd-journal-logger]: https://docs.rs/systemd-journal-logger/*/systemd_journal_logger/ //! [android_log]: https://docs.rs/android_log/*/android_log/ //! [win_dbg_logger]: https://docs.rs/win_dbg_logger/*/win_dbg_logger/ //! [db_logger]: https://docs.rs/db_logger/*/db_logger/ //! [log-to-defmt]: https://docs.rs/log-to-defmt/*/log_to_defmt/ //! [console_log]: https://docs.rs/console_log/*/console_log/ //! [structured-logger]: https://docs.rs/structured-logger/latest/structured_logger/ #![doc( html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://www.rust-lang.org/favicon.ico", html_root_url = "https://docs.rs/log/0.4.20" )] #![warn(missing_docs)] #![deny(missing_debug_implementations, unconditional_recursion)] #![cfg_attr(all(not(feature = "std"), not(test)), no_std)] // When compiled for the rustc compiler itself we want to make sure that this is // an unstable crate #![cfg_attr(rustbuild, feature(staged_api, rustc_private))] #![cfg_attr(rustbuild, unstable(feature = "rustc_private", issue = "27812"))] #[cfg(all(not(feature = "std"), not(test)))] extern crate core as std; use std::cmp; #[cfg(feature = "std")] use std::error; use std::fmt; use std::mem; use std::str::FromStr; #[macro_use] mod macros; mod serde; #[cfg(feature = "kv_unstable")] pub mod kv; #[cfg(target_has_atomic = "ptr")] use std::sync::atomic::{AtomicUsize, Ordering}; #[cfg(not(target_has_atomic = "ptr"))] use std::cell::Cell; #[cfg(not(target_has_atomic = "ptr"))] use std::sync::atomic::Ordering; #[cfg(not(target_has_atomic = "ptr"))] struct AtomicUsize { v: Cell, } #[cfg(not(target_has_atomic = "ptr"))] impl AtomicUsize { const fn new(v: usize) -> AtomicUsize { AtomicUsize { v: Cell::new(v) } } fn load(&self, _order: Ordering) -> usize { self.v.get() } fn store(&self, val: usize, _order: Ordering) { self.v.set(val) } #[cfg(target_has_atomic = "ptr")] fn compare_exchange( &self, current: usize, new: usize, _success: Ordering, _failure: Ordering, ) -> Result { let prev = self.v.get(); if current == prev { self.v.set(new); } Ok(prev) } } // Any platform without atomics is unlikely to have multiple cores, so // writing via Cell will not be a race condition. #[cfg(not(target_has_atomic = "ptr"))] unsafe impl Sync for AtomicUsize {} // The LOGGER static holds a pointer to the global logger. It is protected by // the STATE static which determines whether LOGGER has been initialized yet. static mut LOGGER: &dyn Log = &NopLogger; static STATE: AtomicUsize = AtomicUsize::new(0); // There are three different states that we care about: the logger's // uninitialized, the logger's initializing (set_logger's been called but // LOGGER hasn't actually been set yet), or the logger's active. const UNINITIALIZED: usize = 0; const INITIALIZING: usize = 1; const INITIALIZED: usize = 2; static MAX_LOG_LEVEL_FILTER: AtomicUsize = AtomicUsize::new(0); static LOG_LEVEL_NAMES: [&str; 6] = ["OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE"]; static SET_LOGGER_ERROR: &str = "attempted to set a logger after the logging system \ was already initialized"; static LEVEL_PARSE_ERROR: &str = "attempted to convert a string that doesn't match an existing log level"; /// An enum representing the available verbosity levels of the logger. /// /// Typical usage includes: checking if a certain `Level` is enabled with /// [`log_enabled!`](macro.log_enabled.html), specifying the `Level` of /// [`log!`](macro.log.html), and comparing a `Level` directly to a /// [`LevelFilter`](enum.LevelFilter.html). #[repr(usize)] #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)] pub enum Level { /// The "error" level. /// /// Designates very serious errors. // This way these line up with the discriminants for LevelFilter below // This works because Rust treats field-less enums the same way as C does: // https://doc.rust-lang.org/reference/items/enumerations.html#custom-discriminant-values-for-field-less-enumerations Error = 1, /// The "warn" level. /// /// Designates hazardous situations. Warn, /// The "info" level. /// /// Designates useful information. Info, /// The "debug" level. /// /// Designates lower priority information. Debug, /// The "trace" level. /// /// Designates very low priority, often extremely verbose, information. Trace, } impl PartialEq for Level { #[inline] fn eq(&self, other: &LevelFilter) -> bool { *self as usize == *other as usize } } impl PartialOrd for Level { #[inline] fn partial_cmp(&self, other: &LevelFilter) -> Option { Some((*self as usize).cmp(&(*other as usize))) } } fn ok_or(t: Option, e: E) -> Result { match t { Some(t) => Ok(t), None => Err(e), } } impl FromStr for Level { type Err = ParseLevelError; fn from_str(level: &str) -> Result { ok_or( LOG_LEVEL_NAMES .iter() .position(|&name| name.eq_ignore_ascii_case(level)) .into_iter() .filter(|&idx| idx != 0) .map(|idx| Level::from_usize(idx).unwrap()) .next(), ParseLevelError(()), ) } } impl fmt::Display for Level { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.pad(self.as_str()) } } impl Level { fn from_usize(u: usize) -> Option { match u { 1 => Some(Level::Error), 2 => Some(Level::Warn), 3 => Some(Level::Info), 4 => Some(Level::Debug), 5 => Some(Level::Trace), _ => None, } } /// Returns the most verbose logging level. #[inline] pub fn max() -> Level { Level::Trace } /// Converts the `Level` to the equivalent `LevelFilter`. #[inline] pub fn to_level_filter(&self) -> LevelFilter { LevelFilter::from_usize(*self as usize).unwrap() } /// Returns the string representation of the `Level`. /// /// This returns the same string as the `fmt::Display` implementation. pub fn as_str(&self) -> &'static str { LOG_LEVEL_NAMES[*self as usize] } /// Iterate through all supported logging levels. /// /// The order of iteration is from more severe to less severe log messages. /// /// # Examples /// /// ``` /// use log::Level; /// /// let mut levels = Level::iter(); /// /// assert_eq!(Some(Level::Error), levels.next()); /// assert_eq!(Some(Level::Trace), levels.last()); /// ``` pub fn iter() -> impl Iterator { (1..6).map(|i| Self::from_usize(i).unwrap()) } } /// An enum representing the available verbosity level filters of the logger. /// /// A `LevelFilter` may be compared directly to a [`Level`]. Use this type /// to get and set the maximum log level with [`max_level()`] and [`set_max_level`]. /// /// [`Level`]: enum.Level.html /// [`max_level()`]: fn.max_level.html /// [`set_max_level`]: fn.set_max_level.html #[repr(usize)] #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)] pub enum LevelFilter { /// A level lower than all log levels. Off, /// Corresponds to the `Error` log level. Error, /// Corresponds to the `Warn` log level. Warn, /// Corresponds to the `Info` log level. Info, /// Corresponds to the `Debug` log level. Debug, /// Corresponds to the `Trace` log level. Trace, } impl PartialEq for LevelFilter { #[inline] fn eq(&self, other: &Level) -> bool { other.eq(self) } } impl PartialOrd for LevelFilter { #[inline] fn partial_cmp(&self, other: &Level) -> Option { Some((*self as usize).cmp(&(*other as usize))) } } impl FromStr for LevelFilter { type Err = ParseLevelError; fn from_str(level: &str) -> Result { ok_or( LOG_LEVEL_NAMES .iter() .position(|&name| name.eq_ignore_ascii_case(level)) .map(|p| LevelFilter::from_usize(p).unwrap()), ParseLevelError(()), ) } } impl fmt::Display for LevelFilter { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.pad(self.as_str()) } } impl LevelFilter { fn from_usize(u: usize) -> Option { match u { 0 => Some(LevelFilter::Off), 1 => Some(LevelFilter::Error), 2 => Some(LevelFilter::Warn), 3 => Some(LevelFilter::Info), 4 => Some(LevelFilter::Debug), 5 => Some(LevelFilter::Trace), _ => None, } } /// Returns the most verbose logging level filter. #[inline] pub fn max() -> LevelFilter { LevelFilter::Trace } /// Converts `self` to the equivalent `Level`. /// /// Returns `None` if `self` is `LevelFilter::Off`. #[inline] pub fn to_level(&self) -> Option { Level::from_usize(*self as usize) } /// Returns the string representation of the `LevelFilter`. /// /// This returns the same string as the `fmt::Display` implementation. pub fn as_str(&self) -> &'static str { LOG_LEVEL_NAMES[*self as usize] } /// Iterate through all supported filtering levels. /// /// The order of iteration is from less to more verbose filtering. /// /// # Examples /// /// ``` /// use log::LevelFilter; /// /// let mut levels = LevelFilter::iter(); /// /// assert_eq!(Some(LevelFilter::Off), levels.next()); /// assert_eq!(Some(LevelFilter::Trace), levels.last()); /// ``` pub fn iter() -> impl Iterator { (0..6).map(|i| Self::from_usize(i).unwrap()) } } #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)] enum MaybeStaticStr<'a> { Static(&'static str), Borrowed(&'a str), } impl<'a> MaybeStaticStr<'a> { #[inline] fn get(&self) -> &'a str { match *self { MaybeStaticStr::Static(s) => s, MaybeStaticStr::Borrowed(s) => s, } } } /// The "payload" of a log message. /// /// # Use /// /// `Record` structures are passed as parameters to the [`log`][method.log] /// method of the [`Log`] trait. Logger implementors manipulate these /// structures in order to display log messages. `Record`s are automatically /// created by the [`log!`] macro and so are not seen by log users. /// /// Note that the [`level()`] and [`target()`] accessors are equivalent to /// `self.metadata().level()` and `self.metadata().target()` respectively. /// These methods are provided as a convenience for users of this structure. /// /// # Example /// /// The following example shows a simple logger that displays the level, /// module path, and message of any `Record` that is passed to it. /// /// ```edition2018 /// struct SimpleLogger; /// /// impl log::Log for SimpleLogger { /// fn enabled(&self, _metadata: &log::Metadata) -> bool { /// true /// } /// /// fn log(&self, record: &log::Record) { /// if !self.enabled(record.metadata()) { /// return; /// } /// /// println!("{}:{} -- {}", /// record.level(), /// record.target(), /// record.args()); /// } /// fn flush(&self) {} /// } /// ``` /// /// [method.log]: trait.Log.html#tymethod.log /// [`Log`]: trait.Log.html /// [`log!`]: macro.log.html /// [`level()`]: struct.Record.html#method.level /// [`target()`]: struct.Record.html#method.target #[derive(Clone, Debug)] pub struct Record<'a> { metadata: Metadata<'a>, args: fmt::Arguments<'a>, module_path: Option>, file: Option>, line: Option, #[cfg(feature = "kv_unstable")] key_values: KeyValues<'a>, } // This wrapper type is only needed so we can // `#[derive(Debug)]` on `Record`. It also // provides a useful `Debug` implementation for // the underlying `Source`. #[cfg(feature = "kv_unstable")] #[derive(Clone)] struct KeyValues<'a>(&'a dyn kv::Source); #[cfg(feature = "kv_unstable")] impl<'a> fmt::Debug for KeyValues<'a> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut visitor = f.debug_map(); self.0.visit(&mut visitor).map_err(|_| fmt::Error)?; visitor.finish() } } impl<'a> Record<'a> { /// Returns a new builder. #[inline] pub fn builder() -> RecordBuilder<'a> { RecordBuilder::new() } /// The message body. #[inline] pub fn args(&self) -> &fmt::Arguments<'a> { &self.args } /// Metadata about the log directive. #[inline] pub fn metadata(&self) -> &Metadata<'a> { &self.metadata } /// The verbosity level of the message. #[inline] pub fn level(&self) -> Level { self.metadata.level() } /// The name of the target of the directive. #[inline] pub fn target(&self) -> &'a str { self.metadata.target() } /// The module path of the message. #[inline] pub fn module_path(&self) -> Option<&'a str> { self.module_path.map(|s| s.get()) } /// The module path of the message, if it is a `'static` string. #[inline] pub fn module_path_static(&self) -> Option<&'static str> { match self.module_path { Some(MaybeStaticStr::Static(s)) => Some(s), _ => None, } } /// The source file containing the message. #[inline] pub fn file(&self) -> Option<&'a str> { self.file.map(|s| s.get()) } /// The module path of the message, if it is a `'static` string. #[inline] pub fn file_static(&self) -> Option<&'static str> { match self.file { Some(MaybeStaticStr::Static(s)) => Some(s), _ => None, } } /// The line containing the message. #[inline] pub fn line(&self) -> Option { self.line } /// The structured key-value pairs associated with the message. #[cfg(feature = "kv_unstable")] #[inline] pub fn key_values(&self) -> &dyn kv::Source { self.key_values.0 } /// Create a new [`RecordBuilder`](struct.RecordBuilder.html) based on this record. #[cfg(feature = "kv_unstable")] #[inline] pub fn to_builder(&self) -> RecordBuilder { RecordBuilder { record: Record { metadata: Metadata { level: self.metadata.level, target: self.metadata.target, }, args: self.args, module_path: self.module_path, file: self.file, line: self.line, key_values: self.key_values.clone(), }, } } } /// Builder for [`Record`](struct.Record.html). /// /// Typically should only be used by log library creators or for testing and "shim loggers". /// The `RecordBuilder` can set the different parameters of `Record` object, and returns /// the created object when `build` is called. /// /// # Examples /// /// ```edition2018 /// use log::{Level, Record}; /// /// let record = Record::builder() /// .args(format_args!("Error!")) /// .level(Level::Error) /// .target("myApp") /// .file(Some("server.rs")) /// .line(Some(144)) /// .module_path(Some("server")) /// .build(); /// ``` /// /// Alternatively, use [`MetadataBuilder`](struct.MetadataBuilder.html): /// /// ```edition2018 /// use log::{Record, Level, MetadataBuilder}; /// /// let error_metadata = MetadataBuilder::new() /// .target("myApp") /// .level(Level::Error) /// .build(); /// /// let record = Record::builder() /// .metadata(error_metadata) /// .args(format_args!("Error!")) /// .line(Some(433)) /// .file(Some("app.rs")) /// .module_path(Some("server")) /// .build(); /// ``` #[derive(Debug)] pub struct RecordBuilder<'a> { record: Record<'a>, } impl<'a> RecordBuilder<'a> { /// Construct new `RecordBuilder`. /// /// The default options are: /// /// - `args`: [`format_args!("")`] /// - `metadata`: [`Metadata::builder().build()`] /// - `module_path`: `None` /// - `file`: `None` /// - `line`: `None` /// /// [`format_args!("")`]: https://doc.rust-lang.org/std/macro.format_args.html /// [`Metadata::builder().build()`]: struct.MetadataBuilder.html#method.build #[inline] pub fn new() -> RecordBuilder<'a> { RecordBuilder { record: Record { args: format_args!(""), metadata: Metadata::builder().build(), module_path: None, file: None, line: None, #[cfg(feature = "kv_unstable")] key_values: KeyValues(&Option::None::<(kv::Key, kv::Value)>), }, } } /// Set [`args`](struct.Record.html#method.args). #[inline] pub fn args(&mut self, args: fmt::Arguments<'a>) -> &mut RecordBuilder<'a> { self.record.args = args; self } /// Set [`metadata`](struct.Record.html#method.metadata). Construct a `Metadata` object with [`MetadataBuilder`](struct.MetadataBuilder.html). #[inline] pub fn metadata(&mut self, metadata: Metadata<'a>) -> &mut RecordBuilder<'a> { self.record.metadata = metadata; self } /// Set [`Metadata::level`](struct.Metadata.html#method.level). #[inline] pub fn level(&mut self, level: Level) -> &mut RecordBuilder<'a> { self.record.metadata.level = level; self } /// Set [`Metadata::target`](struct.Metadata.html#method.target) #[inline] pub fn target(&mut self, target: &'a str) -> &mut RecordBuilder<'a> { self.record.metadata.target = target; self } /// Set [`module_path`](struct.Record.html#method.module_path) #[inline] pub fn module_path(&mut self, path: Option<&'a str>) -> &mut RecordBuilder<'a> { self.record.module_path = path.map(MaybeStaticStr::Borrowed); self } /// Set [`module_path`](struct.Record.html#method.module_path) to a `'static` string #[inline] pub fn module_path_static(&mut self, path: Option<&'static str>) -> &mut RecordBuilder<'a> { self.record.module_path = path.map(MaybeStaticStr::Static); self } /// Set [`file`](struct.Record.html#method.file) #[inline] pub fn file(&mut self, file: Option<&'a str>) -> &mut RecordBuilder<'a> { self.record.file = file.map(MaybeStaticStr::Borrowed); self } /// Set [`file`](struct.Record.html#method.file) to a `'static` string. #[inline] pub fn file_static(&mut self, file: Option<&'static str>) -> &mut RecordBuilder<'a> { self.record.file = file.map(MaybeStaticStr::Static); self } /// Set [`line`](struct.Record.html#method.line) #[inline] pub fn line(&mut self, line: Option) -> &mut RecordBuilder<'a> { self.record.line = line; self } /// Set [`key_values`](struct.Record.html#method.key_values) #[cfg(feature = "kv_unstable")] #[inline] pub fn key_values(&mut self, kvs: &'a dyn kv::Source) -> &mut RecordBuilder<'a> { self.record.key_values = KeyValues(kvs); self } /// Invoke the builder and return a `Record` #[inline] pub fn build(&self) -> Record<'a> { self.record.clone() } } impl<'a> Default for RecordBuilder<'a> { fn default() -> Self { Self::new() } } /// Metadata about a log message. /// /// # Use /// /// `Metadata` structs are created when users of the library use /// logging macros. /// /// They are consumed by implementations of the `Log` trait in the /// `enabled` method. /// /// `Record`s use `Metadata` to determine the log message's severity /// and target. /// /// Users should use the `log_enabled!` macro in their code to avoid /// constructing expensive log messages. /// /// # Examples /// /// ```edition2018 /// use log::{Record, Level, Metadata}; /// /// struct MyLogger; /// /// impl log::Log for MyLogger { /// fn enabled(&self, metadata: &Metadata) -> bool { /// metadata.level() <= Level::Info /// } /// /// fn log(&self, record: &Record) { /// if self.enabled(record.metadata()) { /// println!("{} - {}", record.level(), record.args()); /// } /// } /// fn flush(&self) {} /// } /// /// # fn main(){} /// ``` #[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)] pub struct Metadata<'a> { level: Level, target: &'a str, } impl<'a> Metadata<'a> { /// Returns a new builder. #[inline] pub fn builder() -> MetadataBuilder<'a> { MetadataBuilder::new() } /// The verbosity level of the message. #[inline] pub fn level(&self) -> Level { self.level } /// The name of the target of the directive. #[inline] pub fn target(&self) -> &'a str { self.target } } /// Builder for [`Metadata`](struct.Metadata.html). /// /// Typically should only be used by log library creators or for testing and "shim loggers". /// The `MetadataBuilder` can set the different parameters of a `Metadata` object, and returns /// the created object when `build` is called. /// /// # Example /// /// ```edition2018 /// let target = "myApp"; /// use log::{Level, MetadataBuilder}; /// let metadata = MetadataBuilder::new() /// .level(Level::Debug) /// .target(target) /// .build(); /// ``` #[derive(Eq, PartialEq, Ord, PartialOrd, Hash, Debug)] pub struct MetadataBuilder<'a> { metadata: Metadata<'a>, } impl<'a> MetadataBuilder<'a> { /// Construct a new `MetadataBuilder`. /// /// The default options are: /// /// - `level`: `Level::Info` /// - `target`: `""` #[inline] pub fn new() -> MetadataBuilder<'a> { MetadataBuilder { metadata: Metadata { level: Level::Info, target: "", }, } } /// Setter for [`level`](struct.Metadata.html#method.level). #[inline] pub fn level(&mut self, arg: Level) -> &mut MetadataBuilder<'a> { self.metadata.level = arg; self } /// Setter for [`target`](struct.Metadata.html#method.target). #[inline] pub fn target(&mut self, target: &'a str) -> &mut MetadataBuilder<'a> { self.metadata.target = target; self } /// Returns a `Metadata` object. #[inline] pub fn build(&self) -> Metadata<'a> { self.metadata.clone() } } impl<'a> Default for MetadataBuilder<'a> { fn default() -> Self { Self::new() } } /// A trait encapsulating the operations required of a logger. pub trait Log: Sync + Send { /// Determines if a log message with the specified metadata would be /// logged. /// /// This is used by the `log_enabled!` macro to allow callers to avoid /// expensive computation of log message arguments if the message would be /// discarded anyway. /// /// # For implementors /// /// This method isn't called automatically by the `log!` macros. /// It's up to an implementation of the `Log` trait to call `enabled` in its own /// `log` method implementation to guarantee that filtering is applied. fn enabled(&self, metadata: &Metadata) -> bool; /// Logs the `Record`. /// /// # For implementors /// /// Note that `enabled` is *not* necessarily called before this method. /// Implementations of `log` should perform all necessary filtering /// internally. fn log(&self, record: &Record); /// Flushes any buffered records. fn flush(&self); } // Just used as a dummy initial value for LOGGER struct NopLogger; impl Log for NopLogger { fn enabled(&self, _: &Metadata) -> bool { false } fn log(&self, _: &Record) {} fn flush(&self) {} } impl Log for &'_ T where T: ?Sized + Log, { fn enabled(&self, metadata: &Metadata) -> bool { (**self).enabled(metadata) } fn log(&self, record: &Record) { (**self).log(record); } fn flush(&self) { (**self).flush(); } } #[cfg(feature = "std")] impl Log for std::boxed::Box where T: ?Sized + Log, { fn enabled(&self, metadata: &Metadata) -> bool { self.as_ref().enabled(metadata) } fn log(&self, record: &Record) { self.as_ref().log(record) } fn flush(&self) { self.as_ref().flush() } } #[cfg(feature = "std")] impl Log for std::sync::Arc where T: ?Sized + Log, { fn enabled(&self, metadata: &Metadata) -> bool { self.as_ref().enabled(metadata) } fn log(&self, record: &Record) { self.as_ref().log(record) } fn flush(&self) { self.as_ref().flush() } } /// Sets the global maximum log level. /// /// Generally, this should only be called by the active logging implementation. /// /// Note that `Trace` is the maximum level, because it provides the maximum amount of detail in the emitted logs. #[inline] #[cfg(target_has_atomic = "ptr")] pub fn set_max_level(level: LevelFilter) { MAX_LOG_LEVEL_FILTER.store(level as usize, Ordering::Relaxed); } /// A thread-unsafe version of [`set_max_level`]. /// /// This function is available on all platforms, even those that do not have /// support for atomics that is needed by [`set_max_level`]. /// /// In almost all cases, [`set_max_level`] should be preferred. /// /// # Safety /// /// This function is only safe to call when no other level setting function is /// called while this function still executes. /// /// This can be upheld by (for example) making sure that **there are no other /// threads**, and (on embedded) that **interrupts are disabled**. /// /// Is is safe to use all other logging functions while this function runs /// (including all logging macros). /// /// [`set_max_level`]: fn.set_max_level.html #[inline] pub unsafe fn set_max_level_racy(level: LevelFilter) { // `MAX_LOG_LEVEL_FILTER` uses a `Cell` as the underlying primitive when a // platform doesn't support `target_has_atomic = "ptr"`, so even though this looks the same // as `set_max_level` it may have different safety properties. MAX_LOG_LEVEL_FILTER.store(level as usize, Ordering::Relaxed); } /// Returns the current maximum log level. /// /// The [`log!`], [`error!`], [`warn!`], [`info!`], [`debug!`], and [`trace!`] macros check /// this value and discard any message logged at a higher level. The maximum /// log level is set by the [`set_max_level`] function. /// /// [`log!`]: macro.log.html /// [`error!`]: macro.error.html /// [`warn!`]: macro.warn.html /// [`info!`]: macro.info.html /// [`debug!`]: macro.debug.html /// [`trace!`]: macro.trace.html /// [`set_max_level`]: fn.set_max_level.html #[inline(always)] pub fn max_level() -> LevelFilter { // Since `LevelFilter` is `repr(usize)`, // this transmute is sound if and only if `MAX_LOG_LEVEL_FILTER` // is set to a usize that is a valid discriminant for `LevelFilter`. // Since `MAX_LOG_LEVEL_FILTER` is private, the only time it's set // is by `set_max_level` above, i.e. by casting a `LevelFilter` to `usize`. // So any usize stored in `MAX_LOG_LEVEL_FILTER` is a valid discriminant. unsafe { mem::transmute(MAX_LOG_LEVEL_FILTER.load(Ordering::Relaxed)) } } /// Sets the global logger to a `Box`. /// /// This is a simple convenience wrapper over `set_logger`, which takes a /// `Box` rather than a `&'static Log`. See the documentation for /// [`set_logger`] for more details. /// /// Requires the `std` feature. /// /// # Errors /// /// An error is returned if a logger has already been set. /// /// [`set_logger`]: fn.set_logger.html #[cfg(all(feature = "std", target_has_atomic = "ptr"))] pub fn set_boxed_logger(logger: Box) -> Result<(), SetLoggerError> { set_logger_inner(|| Box::leak(logger)) } /// Sets the global logger to a `&'static Log`. /// /// This function may only be called once in the lifetime of a program. Any log /// events that occur before the call to `set_logger` completes will be ignored. /// /// This function does not typically need to be called manually. Logger /// implementations should provide an initialization method that installs the /// logger internally. /// /// # Availability /// /// This method is available even when the `std` feature is disabled. However, /// it is currently unavailable on `thumbv6` targets, which lack support for /// some atomic operations which are used by this function. Even on those /// targets, [`set_logger_racy`] will be available. /// /// # Errors /// /// An error is returned if a logger has already been set. /// /// # Examples /// /// ```edition2018 /// use log::{error, info, warn, Record, Level, Metadata, LevelFilter}; /// /// static MY_LOGGER: MyLogger = MyLogger; /// /// struct MyLogger; /// /// impl log::Log for MyLogger { /// fn enabled(&self, metadata: &Metadata) -> bool { /// metadata.level() <= Level::Info /// } /// /// fn log(&self, record: &Record) { /// if self.enabled(record.metadata()) { /// println!("{} - {}", record.level(), record.args()); /// } /// } /// fn flush(&self) {} /// } /// /// # fn main(){ /// log::set_logger(&MY_LOGGER).unwrap(); /// log::set_max_level(LevelFilter::Info); /// /// info!("hello log"); /// warn!("warning"); /// error!("oops"); /// # } /// ``` /// /// [`set_logger_racy`]: fn.set_logger_racy.html #[cfg(target_has_atomic = "ptr")] pub fn set_logger(logger: &'static dyn Log) -> Result<(), SetLoggerError> { set_logger_inner(|| logger) } #[cfg(target_has_atomic = "ptr")] fn set_logger_inner(make_logger: F) -> Result<(), SetLoggerError> where F: FnOnce() -> &'static dyn Log, { let old_state = match STATE.compare_exchange( UNINITIALIZED, INITIALIZING, Ordering::SeqCst, Ordering::SeqCst, ) { Ok(s) | Err(s) => s, }; match old_state { UNINITIALIZED => { unsafe { LOGGER = make_logger(); } STATE.store(INITIALIZED, Ordering::SeqCst); Ok(()) } INITIALIZING => { while STATE.load(Ordering::SeqCst) == INITIALIZING { // TODO: replace with `hint::spin_loop` once MSRV is 1.49.0. #[allow(deprecated)] std::sync::atomic::spin_loop_hint(); } Err(SetLoggerError(())) } _ => Err(SetLoggerError(())), } } /// A thread-unsafe version of [`set_logger`]. /// /// This function is available on all platforms, even those that do not have /// support for atomics that is needed by [`set_logger`]. /// /// In almost all cases, [`set_logger`] should be preferred. /// /// # Safety /// /// This function is only safe to call when no other logger initialization /// function is called while this function still executes. /// /// This can be upheld by (for example) making sure that **there are no other /// threads**, and (on embedded) that **interrupts are disabled**. /// /// It is safe to use other logging functions while this function runs /// (including all logging macros). /// /// [`set_logger`]: fn.set_logger.html pub unsafe fn set_logger_racy(logger: &'static dyn Log) -> Result<(), SetLoggerError> { match STATE.load(Ordering::SeqCst) { UNINITIALIZED => { LOGGER = logger; STATE.store(INITIALIZED, Ordering::SeqCst); Ok(()) } INITIALIZING => { // This is just plain UB, since we were racing another initialization function unreachable!("set_logger_racy must not be used with other initialization functions") } _ => Err(SetLoggerError(())), } } /// The type returned by [`set_logger`] if [`set_logger`] has already been called. /// /// [`set_logger`]: fn.set_logger.html #[allow(missing_copy_implementations)] #[derive(Debug)] pub struct SetLoggerError(()); impl fmt::Display for SetLoggerError { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.write_str(SET_LOGGER_ERROR) } } // The Error trait is not available in libcore #[cfg(feature = "std")] impl error::Error for SetLoggerError {} /// The type returned by [`from_str`] when the string doesn't match any of the log levels. /// /// [`from_str`]: https://doc.rust-lang.org/std/str/trait.FromStr.html#tymethod.from_str #[allow(missing_copy_implementations)] #[derive(Debug, PartialEq, Eq)] pub struct ParseLevelError(()); impl fmt::Display for ParseLevelError { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.write_str(LEVEL_PARSE_ERROR) } } // The Error trait is not available in libcore #[cfg(feature = "std")] impl error::Error for ParseLevelError {} /// Returns a reference to the logger. /// /// If a logger has not been set, a no-op implementation is returned. pub fn logger() -> &'static dyn Log { if STATE.load(Ordering::SeqCst) != INITIALIZED { static NOP: NopLogger = NopLogger; &NOP } else { unsafe { LOGGER } } } // WARNING: this is not part of the crate's public API and is subject to change at any time #[doc(hidden)] pub mod __private_api; /// The statically resolved maximum log level. /// /// See the crate level documentation for information on how to configure this. /// /// This value is checked by the log macros, but not by the `Log`ger returned by /// the [`logger`] function. Code that manually calls functions on that value /// should compare the level against this value. /// /// [`logger`]: fn.logger.html pub const STATIC_MAX_LEVEL: LevelFilter = MAX_LEVEL_INNER; const MAX_LEVEL_INNER: LevelFilter = get_max_level_inner(); const fn get_max_level_inner() -> LevelFilter { #[allow(unreachable_code)] { #[cfg(all(not(debug_assertions), feature = "release_max_level_off"))] { return LevelFilter::Off; } #[cfg(all(not(debug_assertions), feature = "release_max_level_error"))] { return LevelFilter::Error; } #[cfg(all(not(debug_assertions), feature = "release_max_level_warn"))] { return LevelFilter::Warn; } #[cfg(all(not(debug_assertions), feature = "release_max_level_info"))] { return LevelFilter::Info; } #[cfg(all(not(debug_assertions), feature = "release_max_level_debug"))] { return LevelFilter::Debug; } #[cfg(all(not(debug_assertions), feature = "release_max_level_trace"))] { return LevelFilter::Trace; } #[cfg(feature = "max_level_off")] { return LevelFilter::Off; } #[cfg(feature = "max_level_error")] { return LevelFilter::Error; } #[cfg(feature = "max_level_warn")] { return LevelFilter::Warn; } #[cfg(feature = "max_level_info")] { return LevelFilter::Info; } #[cfg(feature = "max_level_debug")] { return LevelFilter::Debug; } LevelFilter::Trace } } #[cfg(test)] mod tests { extern crate std; use super::{Level, LevelFilter, ParseLevelError}; use tests::std::string::ToString; #[test] fn test_levelfilter_from_str() { let tests = [ ("off", Ok(LevelFilter::Off)), ("error", Ok(LevelFilter::Error)), ("warn", Ok(LevelFilter::Warn)), ("info", Ok(LevelFilter::Info)), ("debug", Ok(LevelFilter::Debug)), ("trace", Ok(LevelFilter::Trace)), ("OFF", Ok(LevelFilter::Off)), ("ERROR", Ok(LevelFilter::Error)), ("WARN", Ok(LevelFilter::Warn)), ("INFO", Ok(LevelFilter::Info)), ("DEBUG", Ok(LevelFilter::Debug)), ("TRACE", Ok(LevelFilter::Trace)), ("asdf", Err(ParseLevelError(()))), ]; for &(s, ref expected) in &tests { assert_eq!(expected, &s.parse()); } } #[test] fn test_level_from_str() { let tests = [ ("OFF", Err(ParseLevelError(()))), ("error", Ok(Level::Error)), ("warn", Ok(Level::Warn)), ("info", Ok(Level::Info)), ("debug", Ok(Level::Debug)), ("trace", Ok(Level::Trace)), ("ERROR", Ok(Level::Error)), ("WARN", Ok(Level::Warn)), ("INFO", Ok(Level::Info)), ("DEBUG", Ok(Level::Debug)), ("TRACE", Ok(Level::Trace)), ("asdf", Err(ParseLevelError(()))), ]; for &(s, ref expected) in &tests { assert_eq!(expected, &s.parse()); } } #[test] fn test_level_as_str() { let tests = &[ (Level::Error, "ERROR"), (Level::Warn, "WARN"), (Level::Info, "INFO"), (Level::Debug, "DEBUG"), (Level::Trace, "TRACE"), ]; for (input, expected) in tests { assert_eq!(*expected, input.as_str()); } } #[test] fn test_level_show() { assert_eq!("INFO", Level::Info.to_string()); assert_eq!("ERROR", Level::Error.to_string()); } #[test] fn test_levelfilter_show() { assert_eq!("OFF", LevelFilter::Off.to_string()); assert_eq!("ERROR", LevelFilter::Error.to_string()); } #[test] fn test_cross_cmp() { assert!(Level::Debug > LevelFilter::Error); assert!(LevelFilter::Warn < Level::Trace); assert!(LevelFilter::Off < Level::Error); } #[test] fn test_cross_eq() { assert!(Level::Error == LevelFilter::Error); assert!(LevelFilter::Off != Level::Error); assert!(Level::Trace == LevelFilter::Trace); } #[test] fn test_to_level() { assert_eq!(Some(Level::Error), LevelFilter::Error.to_level()); assert_eq!(None, LevelFilter::Off.to_level()); assert_eq!(Some(Level::Debug), LevelFilter::Debug.to_level()); } #[test] fn test_to_level_filter() { assert_eq!(LevelFilter::Error, Level::Error.to_level_filter()); assert_eq!(LevelFilter::Trace, Level::Trace.to_level_filter()); } #[test] fn test_level_filter_as_str() { let tests = &[ (LevelFilter::Off, "OFF"), (LevelFilter::Error, "ERROR"), (LevelFilter::Warn, "WARN"), (LevelFilter::Info, "INFO"), (LevelFilter::Debug, "DEBUG"), (LevelFilter::Trace, "TRACE"), ]; for (input, expected) in tests { assert_eq!(*expected, input.as_str()); } } #[test] #[cfg(feature = "std")] fn test_error_trait() { use super::SetLoggerError; let e = SetLoggerError(()); assert_eq!( &e.to_string(), "attempted to set a logger after the logging system \ was already initialized" ); } #[test] fn test_metadata_builder() { use super::MetadataBuilder; let target = "myApp"; let metadata_test = MetadataBuilder::new() .level(Level::Debug) .target(target) .build(); assert_eq!(metadata_test.level(), Level::Debug); assert_eq!(metadata_test.target(), "myApp"); } #[test] fn test_metadata_convenience_builder() { use super::Metadata; let target = "myApp"; let metadata_test = Metadata::builder() .level(Level::Debug) .target(target) .build(); assert_eq!(metadata_test.level(), Level::Debug); assert_eq!(metadata_test.target(), "myApp"); } #[test] fn test_record_builder() { use super::{MetadataBuilder, RecordBuilder}; let target = "myApp"; let metadata = MetadataBuilder::new().target(target).build(); let fmt_args = format_args!("hello"); let record_test = RecordBuilder::new() .args(fmt_args) .metadata(metadata) .module_path(Some("foo")) .file(Some("bar")) .line(Some(30)) .build(); assert_eq!(record_test.metadata().target(), "myApp"); assert_eq!(record_test.module_path(), Some("foo")); assert_eq!(record_test.file(), Some("bar")); assert_eq!(record_test.line(), Some(30)); } #[test] fn test_record_convenience_builder() { use super::{Metadata, Record}; let target = "myApp"; let metadata = Metadata::builder().target(target).build(); let fmt_args = format_args!("hello"); let record_test = Record::builder() .args(fmt_args) .metadata(metadata) .module_path(Some("foo")) .file(Some("bar")) .line(Some(30)) .build(); assert_eq!(record_test.target(), "myApp"); assert_eq!(record_test.module_path(), Some("foo")); assert_eq!(record_test.file(), Some("bar")); assert_eq!(record_test.line(), Some(30)); } #[test] fn test_record_complete_builder() { use super::{Level, Record}; let target = "myApp"; let record_test = Record::builder() .module_path(Some("foo")) .file(Some("bar")) .line(Some(30)) .target(target) .level(Level::Error) .build(); assert_eq!(record_test.target(), "myApp"); assert_eq!(record_test.level(), Level::Error); assert_eq!(record_test.module_path(), Some("foo")); assert_eq!(record_test.file(), Some("bar")); assert_eq!(record_test.line(), Some(30)); } #[test] #[cfg(feature = "kv_unstable")] fn test_record_key_values_builder() { use super::Record; use kv::{self, Visitor}; struct TestVisitor { seen_pairs: usize, } impl<'kvs> Visitor<'kvs> for TestVisitor { fn visit_pair( &mut self, _: kv::Key<'kvs>, _: kv::Value<'kvs>, ) -> Result<(), kv::Error> { self.seen_pairs += 1; Ok(()) } } let kvs: &[(&str, i32)] = &[("a", 1), ("b", 2)]; let record_test = Record::builder().key_values(&kvs).build(); let mut visitor = TestVisitor { seen_pairs: 0 }; record_test.key_values().visit(&mut visitor).unwrap(); assert_eq!(2, visitor.seen_pairs); } #[test] #[cfg(feature = "kv_unstable")] fn test_record_key_values_get_coerce() { use super::Record; let kvs: &[(&str, &str)] = &[("a", "1"), ("b", "2")]; let record = Record::builder().key_values(&kvs).build(); assert_eq!( "2", record .key_values() .get("b".into()) .expect("missing key") .to_borrowed_str() .expect("invalid value") ); } // Test that the `impl Log for Foo` blocks work // This test mostly operates on a type level, so failures will be compile errors #[test] fn test_foreign_impl() { use super::Log; #[cfg(feature = "std")] use std::sync::Arc; fn assert_is_log() {} assert_is_log::<&dyn Log>(); #[cfg(feature = "std")] assert_is_log::>(); #[cfg(feature = "std")] assert_is_log::>(); // Assert these statements for all T: Log + ?Sized #[allow(unused)] fn forall() { #[cfg(feature = "std")] assert_is_log::>(); assert_is_log::<&T>(); #[cfg(feature = "std")] assert_is_log::>(); } } } log-0.4.20/src/macros.rs000064400000000000000000000167421046102023000131230ustar 00000000000000// Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. /// The standard logging macro. /// /// This macro will generically log with the specified `Level` and `format!` /// based argument list. /// /// # Examples /// /// ```edition2018 /// use log::{log, Level}; /// /// # fn main() { /// let data = (42, "Forty-two"); /// let private_data = "private"; /// /// log!(Level::Error, "Received errors: {}, {}", data.0, data.1); /// log!(target: "app_events", Level::Warn, "App warning: {}, {}, {}", /// data.0, data.1, private_data); /// # } /// ``` #[macro_export] macro_rules! log { // log!(target: "my_target", Level::Info, key1 = 42, key2 = true; "a {} event", "log"); (target: $target:expr, $lvl:expr, $($key:tt = $value:expr),+; $($arg:tt)+) => ({ let lvl = $lvl; if lvl <= $crate::STATIC_MAX_LEVEL && lvl <= $crate::max_level() { $crate::__private_api::log( $crate::__private_api::format_args!($($arg)+), lvl, &($target, $crate::__private_api::module_path!(), $crate::__private_api::file!()), $crate::__private_api::line!(), $crate::__private_api::Option::Some(&[$(($crate::__log_key!($key), &$value)),+]) ); } }); // log!(target: "my_target", Level::Info, "a {} event", "log"); (target: $target:expr, $lvl:expr, $($arg:tt)+) => ({ let lvl = $lvl; if lvl <= $crate::STATIC_MAX_LEVEL && lvl <= $crate::max_level() { $crate::__private_api::log( $crate::__private_api::format_args!($($arg)+), lvl, &($target, $crate::__private_api::module_path!(), $crate::__private_api::file!()), $crate::__private_api::line!(), $crate::__private_api::Option::None, ); } }); // log!(Level::Info, "a log event") ($lvl:expr, $($arg:tt)+) => ($crate::log!(target: $crate::__private_api::module_path!(), $lvl, $($arg)+)); } /// Logs a message at the error level. /// /// # Examples /// /// ```edition2018 /// use log::error; /// /// # fn main() { /// let (err_info, port) = ("No connection", 22); /// /// error!("Error: {} on port {}", err_info, port); /// error!(target: "app_events", "App Error: {}, Port: {}", err_info, 22); /// # } /// ``` #[macro_export] macro_rules! error { // error!(target: "my_target", key1 = 42, key2 = true; "a {} event", "log") // error!(target: "my_target", "a {} event", "log") (target: $target:expr, $($arg:tt)+) => ($crate::log!(target: $target, $crate::Level::Error, $($arg)+)); // error!("a {} event", "log") ($($arg:tt)+) => ($crate::log!($crate::Level::Error, $($arg)+)) } /// Logs a message at the warn level. /// /// # Examples /// /// ```edition2018 /// use log::warn; /// /// # fn main() { /// let warn_description = "Invalid Input"; /// /// warn!("Warning! {}!", warn_description); /// warn!(target: "input_events", "App received warning: {}", warn_description); /// # } /// ``` #[macro_export] macro_rules! warn { // warn!(target: "my_target", key1 = 42, key2 = true; "a {} event", "log") // warn!(target: "my_target", "a {} event", "log") (target: $target:expr, $($arg:tt)+) => ($crate::log!(target: $target, $crate::Level::Warn, $($arg)+)); // warn!("a {} event", "log") ($($arg:tt)+) => ($crate::log!($crate::Level::Warn, $($arg)+)) } /// Logs a message at the info level. /// /// # Examples /// /// ```edition2018 /// use log::info; /// /// # fn main() { /// # struct Connection { port: u32, speed: f32 } /// let conn_info = Connection { port: 40, speed: 3.20 }; /// /// info!("Connected to port {} at {} Mb/s", conn_info.port, conn_info.speed); /// info!(target: "connection_events", "Successful connection, port: {}, speed: {}", /// conn_info.port, conn_info.speed); /// # } /// ``` #[macro_export] macro_rules! info { // info!(target: "my_target", key1 = 42, key2 = true; "a {} event", "log") // info!(target: "my_target", "a {} event", "log") (target: $target:expr, $($arg:tt)+) => ($crate::log!(target: $target, $crate::Level::Info, $($arg)+)); // info!("a {} event", "log") ($($arg:tt)+) => ($crate::log!($crate::Level::Info, $($arg)+)) } /// Logs a message at the debug level. /// /// # Examples /// /// ```edition2018 /// use log::debug; /// /// # fn main() { /// # struct Position { x: f32, y: f32 } /// let pos = Position { x: 3.234, y: -1.223 }; /// /// debug!("New position: x: {}, y: {}", pos.x, pos.y); /// debug!(target: "app_events", "New position: x: {}, y: {}", pos.x, pos.y); /// # } /// ``` #[macro_export] macro_rules! debug { // debug!(target: "my_target", key1 = 42, key2 = true; "a {} event", "log") // debug!(target: "my_target", "a {} event", "log") (target: $target:expr, $($arg:tt)+) => ($crate::log!(target: $target, $crate::Level::Debug, $($arg)+)); // debug!("a {} event", "log") ($($arg:tt)+) => ($crate::log!($crate::Level::Debug, $($arg)+)) } /// Logs a message at the trace level. /// /// # Examples /// /// ```edition2018 /// use log::trace; /// /// # fn main() { /// # struct Position { x: f32, y: f32 } /// let pos = Position { x: 3.234, y: -1.223 }; /// /// trace!("Position is: x: {}, y: {}", pos.x, pos.y); /// trace!(target: "app_events", "x is {} and y is {}", /// if pos.x >= 0.0 { "positive" } else { "negative" }, /// if pos.y >= 0.0 { "positive" } else { "negative" }); /// # } /// ``` #[macro_export] macro_rules! trace { // trace!(target: "my_target", key1 = 42, key2 = true; "a {} event", "log") // trace!(target: "my_target", "a {} event", "log") (target: $target:expr, $($arg:tt)+) => ($crate::log!(target: $target, $crate::Level::Trace, $($arg)+)); // trace!("a {} event", "log") ($($arg:tt)+) => ($crate::log!($crate::Level::Trace, $($arg)+)) } /// Determines if a message logged at the specified level in that module will /// be logged. /// /// This can be used to avoid expensive computation of log message arguments if /// the message would be ignored anyway. /// /// # Examples /// /// ```edition2018 /// use log::Level::Debug; /// use log::{debug, log_enabled}; /// /// # fn foo() { /// if log_enabled!(Debug) { /// let data = expensive_call(); /// debug!("expensive debug data: {} {}", data.x, data.y); /// } /// if log_enabled!(target: "Global", Debug) { /// let data = expensive_call(); /// debug!(target: "Global", "expensive debug data: {} {}", data.x, data.y); /// } /// # } /// # struct Data { x: u32, y: u32 } /// # fn expensive_call() -> Data { Data { x: 0, y: 0 } } /// # fn main() {} /// ``` #[macro_export] macro_rules! log_enabled { (target: $target:expr, $lvl:expr) => {{ let lvl = $lvl; lvl <= $crate::STATIC_MAX_LEVEL && lvl <= $crate::max_level() && $crate::__private_api::enabled(lvl, $target) }}; ($lvl:expr) => { $crate::log_enabled!(target: $crate::__private_api::module_path!(), $lvl) }; } #[doc(hidden)] #[macro_export] macro_rules! __log_key { // key1 = 42 ($($args:ident)*) => { $crate::__private_api::stringify!($($args)*) }; // "key1" = 42 ($($args:expr)*) => { $($args)* }; } log-0.4.20/src/serde.rs000064400000000000000000000306701046102023000127350ustar 00000000000000#![cfg(feature = "serde")] extern crate serde; use self::serde::de::{ Deserialize, DeserializeSeed, Deserializer, EnumAccess, Error, Unexpected, VariantAccess, Visitor, }; use self::serde::ser::{Serialize, Serializer}; use {Level, LevelFilter, LOG_LEVEL_NAMES}; use std::fmt; use std::str::{self, FromStr}; // The Deserialize impls are handwritten to be case insensitive using FromStr. impl Serialize for Level { fn serialize(&self, serializer: S) -> Result where S: Serializer, { match *self { Level::Error => serializer.serialize_unit_variant("Level", 0, "ERROR"), Level::Warn => serializer.serialize_unit_variant("Level", 1, "WARN"), Level::Info => serializer.serialize_unit_variant("Level", 2, "INFO"), Level::Debug => serializer.serialize_unit_variant("Level", 3, "DEBUG"), Level::Trace => serializer.serialize_unit_variant("Level", 4, "TRACE"), } } } impl<'de> Deserialize<'de> for Level { fn deserialize(deserializer: D) -> Result where D: Deserializer<'de>, { struct LevelIdentifier; impl<'de> Visitor<'de> for LevelIdentifier { type Value = Level; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("log level") } fn visit_str(self, s: &str) -> Result where E: Error, { // Case insensitive. FromStr::from_str(s).map_err(|_| Error::unknown_variant(s, &LOG_LEVEL_NAMES[1..])) } fn visit_bytes(self, value: &[u8]) -> Result where E: Error, { let variant = str::from_utf8(value) .map_err(|_| Error::invalid_value(Unexpected::Bytes(value), &self))?; self.visit_str(variant) } fn visit_u64(self, v: u64) -> Result where E: Error, { let variant = LOG_LEVEL_NAMES[1..] .get(v as usize) .ok_or_else(|| Error::invalid_value(Unexpected::Unsigned(v), &self))?; self.visit_str(variant) } } impl<'de> DeserializeSeed<'de> for LevelIdentifier { type Value = Level; fn deserialize(self, deserializer: D) -> Result where D: Deserializer<'de>, { deserializer.deserialize_identifier(LevelIdentifier) } } struct LevelEnum; impl<'de> Visitor<'de> for LevelEnum { type Value = Level; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("log level") } fn visit_enum(self, value: A) -> Result where A: EnumAccess<'de>, { let (level, variant) = value.variant_seed(LevelIdentifier)?; // Every variant is a unit variant. variant.unit_variant()?; Ok(level) } } deserializer.deserialize_enum("Level", &LOG_LEVEL_NAMES[1..], LevelEnum) } } impl Serialize for LevelFilter { fn serialize(&self, serializer: S) -> Result where S: Serializer, { match *self { LevelFilter::Off => serializer.serialize_unit_variant("LevelFilter", 0, "OFF"), LevelFilter::Error => serializer.serialize_unit_variant("LevelFilter", 1, "ERROR"), LevelFilter::Warn => serializer.serialize_unit_variant("LevelFilter", 2, "WARN"), LevelFilter::Info => serializer.serialize_unit_variant("LevelFilter", 3, "INFO"), LevelFilter::Debug => serializer.serialize_unit_variant("LevelFilter", 4, "DEBUG"), LevelFilter::Trace => serializer.serialize_unit_variant("LevelFilter", 5, "TRACE"), } } } impl<'de> Deserialize<'de> for LevelFilter { fn deserialize(deserializer: D) -> Result where D: Deserializer<'de>, { struct LevelFilterIdentifier; impl<'de> Visitor<'de> for LevelFilterIdentifier { type Value = LevelFilter; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("log level filter") } fn visit_str(self, s: &str) -> Result where E: Error, { // Case insensitive. FromStr::from_str(s).map_err(|_| Error::unknown_variant(s, &LOG_LEVEL_NAMES)) } fn visit_bytes(self, value: &[u8]) -> Result where E: Error, { let variant = str::from_utf8(value) .map_err(|_| Error::invalid_value(Unexpected::Bytes(value), &self))?; self.visit_str(variant) } fn visit_u64(self, v: u64) -> Result where E: Error, { let variant = LOG_LEVEL_NAMES .get(v as usize) .ok_or_else(|| Error::invalid_value(Unexpected::Unsigned(v), &self))?; self.visit_str(variant) } } impl<'de> DeserializeSeed<'de> for LevelFilterIdentifier { type Value = LevelFilter; fn deserialize(self, deserializer: D) -> Result where D: Deserializer<'de>, { deserializer.deserialize_identifier(LevelFilterIdentifier) } } struct LevelFilterEnum; impl<'de> Visitor<'de> for LevelFilterEnum { type Value = LevelFilter; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("log level filter") } fn visit_enum(self, value: A) -> Result where A: EnumAccess<'de>, { let (level_filter, variant) = value.variant_seed(LevelFilterIdentifier)?; // Every variant is a unit variant. variant.unit_variant()?; Ok(level_filter) } } deserializer.deserialize_enum("LevelFilter", &LOG_LEVEL_NAMES, LevelFilterEnum) } } #[cfg(test)] mod tests { extern crate serde_test; use self::serde_test::{assert_de_tokens, assert_de_tokens_error, assert_tokens, Token}; use {Level, LevelFilter}; fn level_token(variant: &'static str) -> Token { Token::UnitVariant { name: "Level", variant: variant, } } fn level_bytes_tokens(variant: &'static [u8]) -> [Token; 3] { [ Token::Enum { name: "Level" }, Token::Bytes(variant), Token::Unit, ] } fn level_variant_tokens(variant: u32) -> [Token; 3] { [ Token::Enum { name: "Level" }, Token::U32(variant), Token::Unit, ] } fn level_filter_token(variant: &'static str) -> Token { Token::UnitVariant { name: "LevelFilter", variant: variant, } } fn level_filter_bytes_tokens(variant: &'static [u8]) -> [Token; 3] { [ Token::Enum { name: "LevelFilter", }, Token::Bytes(variant), Token::Unit, ] } fn level_filter_variant_tokens(variant: u32) -> [Token; 3] { [ Token::Enum { name: "LevelFilter", }, Token::U32(variant), Token::Unit, ] } #[test] fn test_level_ser_de() { let cases = [ (Level::Error, [level_token("ERROR")]), (Level::Warn, [level_token("WARN")]), (Level::Info, [level_token("INFO")]), (Level::Debug, [level_token("DEBUG")]), (Level::Trace, [level_token("TRACE")]), ]; for &(s, expected) in &cases { assert_tokens(&s, &expected); } } #[test] fn test_level_case_insensitive() { let cases = [ (Level::Error, [level_token("error")]), (Level::Warn, [level_token("warn")]), (Level::Info, [level_token("info")]), (Level::Debug, [level_token("debug")]), (Level::Trace, [level_token("trace")]), ]; for &(s, expected) in &cases { assert_de_tokens(&s, &expected); } } #[test] fn test_level_de_bytes() { let cases = [ (Level::Error, level_bytes_tokens(b"ERROR")), (Level::Warn, level_bytes_tokens(b"WARN")), (Level::Info, level_bytes_tokens(b"INFO")), (Level::Debug, level_bytes_tokens(b"DEBUG")), (Level::Trace, level_bytes_tokens(b"TRACE")), ]; for &(value, tokens) in &cases { assert_de_tokens(&value, &tokens); } } #[test] fn test_level_de_variant_index() { let cases = [ (Level::Error, level_variant_tokens(0)), (Level::Warn, level_variant_tokens(1)), (Level::Info, level_variant_tokens(2)), (Level::Debug, level_variant_tokens(3)), (Level::Trace, level_variant_tokens(4)), ]; for &(value, tokens) in &cases { assert_de_tokens(&value, &tokens); } } #[test] fn test_level_de_error() { let msg = "unknown variant `errorx`, expected one of \ `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`"; assert_de_tokens_error::(&[level_token("errorx")], msg); } #[test] fn test_level_filter_ser_de() { let cases = [ (LevelFilter::Off, [level_filter_token("OFF")]), (LevelFilter::Error, [level_filter_token("ERROR")]), (LevelFilter::Warn, [level_filter_token("WARN")]), (LevelFilter::Info, [level_filter_token("INFO")]), (LevelFilter::Debug, [level_filter_token("DEBUG")]), (LevelFilter::Trace, [level_filter_token("TRACE")]), ]; for &(s, expected) in &cases { assert_tokens(&s, &expected); } } #[test] fn test_level_filter_case_insensitive() { let cases = [ (LevelFilter::Off, [level_filter_token("off")]), (LevelFilter::Error, [level_filter_token("error")]), (LevelFilter::Warn, [level_filter_token("warn")]), (LevelFilter::Info, [level_filter_token("info")]), (LevelFilter::Debug, [level_filter_token("debug")]), (LevelFilter::Trace, [level_filter_token("trace")]), ]; for &(s, expected) in &cases { assert_de_tokens(&s, &expected); } } #[test] fn test_level_filter_de_bytes() { let cases = [ (LevelFilter::Off, level_filter_bytes_tokens(b"OFF")), (LevelFilter::Error, level_filter_bytes_tokens(b"ERROR")), (LevelFilter::Warn, level_filter_bytes_tokens(b"WARN")), (LevelFilter::Info, level_filter_bytes_tokens(b"INFO")), (LevelFilter::Debug, level_filter_bytes_tokens(b"DEBUG")), (LevelFilter::Trace, level_filter_bytes_tokens(b"TRACE")), ]; for &(value, tokens) in &cases { assert_de_tokens(&value, &tokens); } } #[test] fn test_level_filter_de_variant_index() { let cases = [ (LevelFilter::Off, level_filter_variant_tokens(0)), (LevelFilter::Error, level_filter_variant_tokens(1)), (LevelFilter::Warn, level_filter_variant_tokens(2)), (LevelFilter::Info, level_filter_variant_tokens(3)), (LevelFilter::Debug, level_filter_variant_tokens(4)), (LevelFilter::Trace, level_filter_variant_tokens(5)), ]; for &(value, tokens) in &cases { assert_de_tokens(&value, &tokens); } } #[test] fn test_level_filter_de_error() { let msg = "unknown variant `errorx`, expected one of \ `OFF`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`"; assert_de_tokens_error::(&[level_filter_token("errorx")], msg); } } log-0.4.20/triagebot.toml000064400000000000000000000000111046102023000133350ustar 00000000000000[assign]