#defmt #logging #log-debug #debugging #debugging-logging

no-std defmt-or-log

Logging macros that forward to either defmt or log

4 releases

0.2.1 Jan 16, 2024
0.2.0 Nov 20, 2023
0.1.1 Nov 20, 2023
0.1.0 Nov 20, 2023

#415 in Embedded development

Download history 339/week @ 2024-07-20 541/week @ 2024-07-27 563/week @ 2024-08-03 497/week @ 2024-08-10 521/week @ 2024-08-17 685/week @ 2024-08-24 397/week @ 2024-08-31 250/week @ 2024-09-07 237/week @ 2024-09-14 614/week @ 2024-09-21 478/week @ 2024-09-28 541/week @ 2024-10-05 632/week @ 2024-10-12 452/week @ 2024-10-19 567/week @ 2024-10-26 1267/week @ 2024-11-02

3,121 downloads per month
Used in 4 crates (3 directly)

MIT/Apache

13KB
270 lines

defmt-or-log

In embedded projects you often want to log something either via core::fmt::Debug or defmt::Format, depending on the configuration. The crate defmt-or-log provides the usual logger macros and either forwards them to the log or defmt crate, depending on the enabled features.

Furthermore, the defmt-or-log crate provides:

  • the FormatOrDebug trait, that uses core::fmt::Debug or defmt::Format as super-trait and provides matching blanket implementations. This is useful for specifying trait bounds.
  • the Debug2Format struct, which behaves similar to defmt::Debug2Format, but does nothing extra if using log.
  • the Display2Format struct, which behaves similar to defmt::Display2Format, but does nothing extra if using log.

See examples/derive.rs.

You may either enable the log or the defmt feature but not both.
The feature at_least_one (enabled per default) generates a compiler error if neither log nor defmt are enabled.

This repository, also provides the defmt-or-log-macros crate, that contains Proc Macros to conditonally derive core::fmt::Debug or defmt::Format, depending on the enabled features.

Supported macros (defmt-or-log crate):

  • trace

  • debug

  • info

  • warn

  • error

  • assert

  • assert_eq

  • assert_ne

  • debug_assert

  • debug_assert_eq

  • debug_assert_ne

  • todo

  • unreachable

  • panic

  • unwrap

  • intern

License

Licensed under either of:

at your option.

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.

Dependencies

~225–740KB
~17K SLoC