#logging #defmt #config #no-std

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

#539 in Embedded development

Download history 370/week @ 2024-11-30 821/week @ 2024-12-07 362/week @ 2024-12-14 107/week @ 2024-12-21 123/week @ 2024-12-28 545/week @ 2025-01-04 458/week @ 2025-01-11 789/week @ 2025-01-18 535/week @ 2025-01-25 1546/week @ 2025-02-01 1837/week @ 2025-02-08 1345/week @ 2025-02-15 1135/week @ 2025-02-22 1337/week @ 2025-03-01 840/week @ 2025-03-08 1411/week @ 2025-03-15

4,858 downloads per month
Used in 5 crates (4 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

~200–710KB
~17K SLoC