add optional automatic defmt implementation #42
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a
defmt
option to thebitfield
macro, which adds code to implementdefmt::Format
. It also adds info to the README and a few appropriate tests.Some implementation notes you might want to know:
defmt::Format
implementations on any custom types. I feel like this better matches the defaultfmt::Debug
implementation. I considered doing both, and making it configurable, but that seemed like too big a change.This macro assumes any type named
u8
is the primitiveu8
, etc. This is also what the official defmt derive macro does, to more efficiently encode these values. It looks like thebitfield
macro already makes this assumption when figuring out default bit widths, so probably not a big deal.The generated code uses
defmt
to refer to defmt, and not::defmt
. This is what the defmt crate itself does in its own macros, for some pretty subtle reasons. I've added a big comment in the code about this, to hopefully prevent somebody from 'fixing' it.Please let me know if you would like any changes, or have any questions!