tracing-proc-macros-ink
| Crates.io | tracing-proc-macros-ink |
| lib.rs | tracing-proc-macros-ink |
| version | 0.1.5 |
| created_at | 2024-12-14 21:21:26.463707+00 |
| updated_at | 2024-12-17 10:23:00.219599+00 |
| description | Provides a working tracing integration for logging from within procedural macros. |
| homepage | https://github.com/ink-feather-org/tracing-proc-macros-ink-rs |
| repository | https://github.com/ink-feather-org/tracing-proc-macros-ink-rs |
| max_upload_size | |
| id | 1483432 |
| size | 35,924 |
Onestacked (onestacked)
documentation
README
tracing-proc-macros-ink
tracing-proc-macros-ink provides a working tracing integration for logging from within procedural macros.
It only works in proc-macro = true crates and is nightly only.
Log records are emitted using nightly compiler diagnostics.
Requirements
This crate requires a nightly compiler.
Usage
Every top level function in your proc_macro crate should call tracing-proc-macros-ink::proc_macro_logger_default_setup() to setup the logger for the proc_macro crate.
After that normal tracing logging can be used in the proc_macro crate.
Example
Check out the example crate example_proc_macro.
How to turn on logging?
By default logging is turned off.
To run it on, you need to set the RUST_LOG environment variable:
RUST_LOG=trace cargo build --workspace --bins
How to speed up the compilation?
To remove the logging calls entirely from the proc_macro crate, you can directly depend on tracing and enable the features that remove the logging calls.
Custom Logger setup
Providing a customized logging setup is trivial.
Copy the code from tracing-proc-macros-ink::proc_macro_logger_default_setup() into your own crate and modify it to your needs.
The default default-setup feature can be disabled with no-default-features = true to avoid enabling unnecessary tracing-subscriber features.
License
This project is released under either:
at your choosing.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.