Add debug check for #[inline] attribute in public derive macro functions #1724
Conversation
This commit introduces a debug-level check to ensure all public functions generated by derive macros include the #[inline] attribute. The check triggers an assertion if any function lacks the attribute. This is done manually because clippy doesn't check missing inline lints in proc macro generated code.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1724 +/- ##
=======================================
Coverage 88.35% 88.35%
=======================================
Files 16 16
Lines 5889 5889
=======================================
Hits 5203 5203
Misses 686 686 ☔ View full report in Codecov by Sentry. |
| fn debug_check_pub_functions_of_trait_are_inlined(expanded_impl_blocks: proc_macro2::TokenStream) { | ||
| let file: syn::File = | ||
| syn::parse2(expanded_impl_blocks).expect("Failed to parse expanded TokenStream"); | ||
|
|
||
| // Iterate over all impl blocks, check if functions have the inline attribute | ||
| for item in file.items { | ||
| if let syn::Item::Impl(item_impl) = item { | ||
| for impl_item in item_impl.items { | ||
| if let syn::ImplItem::Fn(method) = impl_item { | ||
| let has_inline = method.attrs.iter().any(|attr| attr.path().is_ident("inline")); | ||
| debug_assert!( | ||
| has_inline, | ||
| "Method {} does not have #[inline] attribute", | ||
| method.sig.ident | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Can you move this to the end of the file, just above mod tests?
|
Thanks for doing this, @mepatrick73! Just one small nit and a failing test and we should be good to go! |
This commit introduces a debug-level check to ensure all public functions
generated by derive macros include the #[inline] attribute. The check
triggers an assertion if any function lacks the attribute, implemented
manually since Clippy does not currently check for missing inline lints
in proc macro-generated code. This may change if Clippy adds support
for this lint in expanded code.
Additionally, this commit adds #[inline] attributes to public functions
in the derived code.
This fixes part 2 of #7