Add #[must_use] to relevant generated methods - #147
Open
danlehmann wants to merge 2 commits into
Open
Conversation
Most methods on bitfields are without side effects, therefore it makes sense to mark them as `#[must_use]`. * This fixes #140 * Since now, we get a warning on non-used return values on existing builder methods, we have to ignore some return types in the tests * I added a `#![deny(clippy::must_use_candidate)]` to one of the tests to ensure no regression.
- Move the clippy::must_use_candidate enforcement into a dedicated library crate (bitbybit-compile-checks) and lint it explicitly in CI. The lint only applies to genuinely public items, and items inside integration-test binaries are never considered public, so the previous in-test guard in basic.rs was vacuous. - The bitfield in the check crate exercises every generated method shape (plain/indexed getters and setters, ro/wo/rw fields, arbitrary-int fields, and a bitenum custom type), so dropping a #[must_use] from the macro fails it. - CHANGELOG entry
danlehmann
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Most methods on bitfields are without side effects, therefore it makes sense to mark them as
#[must_use].bitfieldmacro triggersclippy::must_use_candidatelints since 2.0.1 #140#![deny(clippy::must_use_candidate)]to one of the tests to ensure no regression.