The `restriction` group contains many lints which are not about necessarily “bad” things, but style choices — perhaps even style choices which contradict conventional Rust style — or are otherwise very situational. This results in silly wording like “Why is this bad? It isn't, but ...”, which I’ve seen confuse a newcomer at least once. To improve this situation, this commit replaces the “Why is this bad?” section heading with “Why restrict this?”, for most, but not all, restriction lints. I left alone the ones whose placement in the restriction group is more incidental. In order to make this make sense, I had to remove the “It isn't, but” texts from the contents of the sections. Sometimes further changes were needed, or there were obvious fixes to make, and I went ahead and made those changes without attempting to split them into another commit, even though many of them are not strictly necessary for the “Why restrict this?” project.
65 lines
2.3 KiB
Rust
65 lines
2.3 KiB
Rust
use clippy_utils::diagnostics::span_lint_and_help;
|
|
use clippy_utils::is_from_proc_macro;
|
|
use rustc_hir::{Expr, ExprKind};
|
|
use rustc_lint::{LateContext, LateLintPass, LintContext};
|
|
use rustc_middle::lint::in_external_macro;
|
|
use rustc_session::declare_lint_pass;
|
|
|
|
declare_clippy_lint! {
|
|
/// ### What it does
|
|
/// Checks for usage of `as` conversions.
|
|
///
|
|
/// Note that this lint is specialized in linting *every single* use of `as`
|
|
/// regardless of whether good alternatives exist or not.
|
|
/// If you want more precise lints for `as`, please consider using these separate lints:
|
|
/// `unnecessary_cast`, `cast_lossless/cast_possible_truncation/cast_possible_wrap/cast_precision_loss/cast_sign_loss`,
|
|
/// `fn_to_numeric_cast(_with_truncation)`, `char_lit_as_u8`, `ref_to_mut` and `ptr_as_ptr`.
|
|
/// There is a good explanation the reason why this lint should work in this way and how it is useful
|
|
/// [in this issue](https://github.com/rust-lang/rust-clippy/issues/5122).
|
|
///
|
|
/// ### Why restrict this?
|
|
/// `as` conversions will perform many kinds of
|
|
/// conversions, including silently lossy conversions and dangerous coercions.
|
|
/// There are cases when it makes sense to use `as`, so the lint is
|
|
/// Allow by default.
|
|
///
|
|
/// ### Example
|
|
/// ```rust,ignore
|
|
/// let a: u32;
|
|
/// ...
|
|
/// f(a as u16);
|
|
/// ```
|
|
///
|
|
/// Use instead:
|
|
/// ```rust,ignore
|
|
/// f(a.try_into()?);
|
|
///
|
|
/// // or
|
|
///
|
|
/// f(a.try_into().expect("Unexpected u16 overflow in f"));
|
|
/// ```
|
|
#[clippy::version = "1.41.0"]
|
|
pub AS_CONVERSIONS,
|
|
restriction,
|
|
"using a potentially dangerous silent `as` conversion"
|
|
}
|
|
|
|
declare_lint_pass!(AsConversions => [AS_CONVERSIONS]);
|
|
|
|
impl<'tcx> LateLintPass<'tcx> for AsConversions {
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &Expr<'tcx>) {
|
|
if let ExprKind::Cast(_, _) = expr.kind
|
|
&& !in_external_macro(cx.sess(), expr.span)
|
|
&& !is_from_proc_macro(cx, expr)
|
|
{
|
|
span_lint_and_help(
|
|
cx,
|
|
AS_CONVERSIONS,
|
|
expr.span,
|
|
"using a potentially dangerous silent `as` conversion",
|
|
None,
|
|
"consider using a safe wrapper for this conversion",
|
|
);
|
|
}
|
|
}
|
|
}
|