1 use clippy_utils::diagnostics::span_lint_and_then;
2 use clippy_utils::macros::span_is_local;
3 use clippy_utils::msrvs::{self, Msrv};
4 use clippy_utils::path_def_id;
5 use clippy_utils::source::snippet_opt;
6 use rustc_errors::Applicability;
7 use rustc_hir::intravisit::{walk_path, Visitor};
9 GenericArg, GenericArgs, HirId, Impl, ImplItemKind, ImplItemRef, Item, ItemKind, PatKind, Path, PathSegment, Ty,
12 use rustc_lint::{LateContext, LateLintPass};
13 use rustc_middle::{hir::nested_filter::OnlyBodies, ty};
14 use rustc_session::{declare_tool_lint, impl_lint_pass};
15 use rustc_span::symbol::{kw, sym};
16 use rustc_span::{Span, Symbol};
18 declare_clippy_lint! {
20 /// Searches for implementations of the `Into<..>` trait and suggests to implement `From<..>` instead.
22 /// ### Why is this bad?
23 /// According the std docs implementing `From<..>` is preferred since it gives you `Into<..>` for free where the reverse isn't true.
27 /// struct StringWrapper(String);
29 /// impl Into<StringWrapper> for String {
30 /// fn into(self) -> StringWrapper {
31 /// StringWrapper(self)
37 /// struct StringWrapper(String);
39 /// impl From<String> for StringWrapper {
40 /// fn from(s: String) -> StringWrapper {
45 #[clippy::version = "1.51.0"]
48 "Warns on implementations of `Into<..>` to use `From<..>`"
51 pub struct FromOverInto {
57 pub fn new(msrv: Msrv) -> Self {
62 impl_lint_pass!(FromOverInto => [FROM_OVER_INTO]);
64 impl<'tcx> LateLintPass<'tcx> for FromOverInto {
65 fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
66 if !self.msrv.meets(msrvs::RE_REBALANCING_COHERENCE) || !span_is_local(item.span) {
70 if let ItemKind::Impl(Impl {
71 of_trait: Some(hir_trait_ref),
73 items: [impl_item_ref],
76 && let Some(into_trait_seg) = hir_trait_ref.path.segments.last()
77 // `impl Into<target_ty> for self_ty`
78 && let Some(GenericArgs { args: [GenericArg::Type(target_ty)], .. }) = into_trait_seg.args
79 && let Some(middle_trait_ref) = cx.tcx.impl_trait_ref(item.owner_id)
80 && cx.tcx.is_diagnostic_item(sym::Into, middle_trait_ref.def_id)
81 && !matches!(middle_trait_ref.substs.type_at(1).kind(), ty::Alias(ty::Opaque, _))
86 cx.tcx.sess.source_map().guess_head_span(item.span),
87 "an implementation of `From` is preferred since it gives you `Into<_>` for free where the reverse isn't true",
89 // If the target type is likely foreign mention the orphan rules as it's a common source of confusion
90 if path_def_id(cx, target_ty.peel_refs()).map_or(true, |id| !id.is_local()) {
92 "`impl From<Local> for Foreign` is allowed by the orphan rules, for more information see\n\
93 https://doc.rust-lang.org/reference/items/implementations.html#trait-implementation-coherence"
97 let message = format!("replace the `Into` implentation with `From<{}>`", middle_trait_ref.self_ty());
98 if let Some(suggestions) = convert_to_from(cx, into_trait_seg, target_ty, self_ty, impl_item_ref) {
99 diag.multipart_suggestion(message, suggestions, Applicability::MachineApplicable);
108 extract_msrv_attr!(LateContext);
111 /// Finds the occurences of `Self` and `self`
112 struct SelfFinder<'a, 'tcx> {
113 cx: &'a LateContext<'tcx>,
114 /// Occurences of `Self`
116 /// Occurences of `self`
118 /// If any of the `self`/`Self` usages were from an expansion, or the body contained a binding
119 /// already named `val`
123 impl<'a, 'tcx> Visitor<'tcx> for SelfFinder<'a, 'tcx> {
124 type NestedFilter = OnlyBodies;
126 fn nested_visit_map(&mut self) -> Self::Map {
130 fn visit_path(&mut self, path: &Path<'tcx>, _id: HirId) {
131 for segment in path.segments {
132 match segment.ident.name {
133 kw::SelfLower => self.lower.push(segment.ident.span),
134 kw::SelfUpper => self.upper.push(segment.ident.span),
139 self.invalid |= path.span.from_expansion();
141 walk_path(self, path);
145 fn visit_name(&mut self, name: Symbol) {
146 if name == sym::val {
153 cx: &LateContext<'_>,
154 into_trait_seg: &PathSegment<'_>,
157 impl_item_ref: &ImplItemRef,
158 ) -> Option<Vec<(Span, String)>> {
159 let impl_item = cx.tcx.hir().impl_item(impl_item_ref.id);
160 let ImplItemKind::Fn(ref sig, body_id) = impl_item.kind else { return None };
161 let body = cx.tcx.hir().body(body_id);
162 let [input] = body.params else { return None };
163 let PatKind::Binding(.., self_ident, None) = input.pat.kind else { return None };
165 let from = snippet_opt(cx, self_ty.span)?;
166 let into = snippet_opt(cx, target_ty.span)?;
168 let mut suggestions = vec![
169 // impl Into<T> for U -> impl From<T> for U
171 (into_trait_seg.ident.span, String::from("From")),
172 // impl Into<T> for U -> impl Into<U> for U
174 (target_ty.span, from.clone()),
175 // impl Into<T> for U -> impl Into<T> for T
177 (self_ty.span, into),
178 // fn into(self) -> T -> fn from(self) -> T
180 (impl_item.ident.span, String::from("from")),
181 // fn into([mut] self) -> T -> fn into([mut] v: T) -> T
183 (self_ident.span, format!("val: {from}")),
184 // fn into(self) -> T -> fn into(self) -> Self
186 (sig.decl.output.span(), String::from("Self")),
189 let mut finder = SelfFinder {
195 finder.visit_expr(body.value);
201 // don't try to replace e.g. `Self::default()` with `&[T]::default()`
202 if !finder.upper.is_empty() && !matches!(self_ty.kind, TyKind::Path(_)) {
206 for span in finder.upper {
207 suggestions.push((span, from.clone()));
209 for span in finder.lower {
210 suggestions.push((span, String::from("val")));