Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: stop dead branch in proc macro from emitting clippy::missing_panics_doc #3595

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: stop dead branch in proc macro from emitting clippy::missing_panics_doc #3595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sqlx-macros-core/src/query/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,9 @@ pub fn quote_args<DB: DatabaseExt>(
_ty_check = match_borrow.match_borrow();

// this causes move-analysis to effectively ignore this block
::std::panic!();
// `panic!` would be enough here but we would then get a warning on `clippy::missing_panics_doc`
// SAFETY: this branch is never reached.
unsafe { ::std::hint::unreachable_unchecked() }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like emitting unsafe from the macros for any reason, honestly. Does unreachable!() emit the same lint warning?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, just #[allow] the lint.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is effectively identical.
The compiler should be able to figure out that anything in if false {...} is unreachable ^^

Though I think clippy should also alert for this (it is still a panic just with a better name. If clippy is not, this is a false negative).

Suggested change
unsafe { ::std::hint::unreachable_unchecked() }
#[allow(clippy::missing_panics_doc)]
::std::unreachable!();

}
))
})
Expand Down