]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_typeck/src/check/compare_method.rs
Rollup merge of #93097 - GuillaumeGomez:settings-js, r=jsha
[rust.git] / compiler / rustc_typeck / src / check / compare_method.rs
1 use crate::errors::LifetimesOrBoundsMismatchOnTrait;
2 use rustc_data_structures::stable_set::FxHashSet;
3 use rustc_errors::{pluralize, struct_span_err, Applicability, DiagnosticId, ErrorGuaranteed};
4 use rustc_hir as hir;
5 use rustc_hir::def::{DefKind, Res};
6 use rustc_hir::intravisit;
7 use rustc_hir::{GenericParamKind, ImplItemKind, TraitItemKind};
8 use rustc_infer::infer::{self, InferOk, TyCtxtInferExt};
9 use rustc_infer::traits::util;
10 use rustc_middle::ty;
11 use rustc_middle::ty::error::{ExpectedFound, TypeError};
12 use rustc_middle::ty::subst::{InternalSubsts, Subst};
13 use rustc_middle::ty::util::ExplicitSelf;
14 use rustc_middle::ty::{GenericParamDefKind, ToPredicate, TyCtxt};
15 use rustc_span::Span;
16 use rustc_trait_selection::traits::error_reporting::InferCtxtExt;
17 use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode, Reveal};
18 use std::iter;
19
20 use super::{potentially_plural_count, FnCtxt, Inherited};
21
22 /// Checks that a method from an impl conforms to the signature of
23 /// the same method as declared in the trait.
24 ///
25 /// # Parameters
26 ///
27 /// - `impl_m`: type of the method we are checking
28 /// - `impl_m_span`: span to use for reporting errors
29 /// - `trait_m`: the method in the trait
30 /// - `impl_trait_ref`: the TraitRef corresponding to the trait implementation
31 crate fn compare_impl_method<'tcx>(
32     tcx: TyCtxt<'tcx>,
33     impl_m: &ty::AssocItem,
34     impl_m_span: Span,
35     trait_m: &ty::AssocItem,
36     impl_trait_ref: ty::TraitRef<'tcx>,
37     trait_item_span: Option<Span>,
38 ) {
39     debug!("compare_impl_method(impl_trait_ref={:?})", impl_trait_ref);
40
41     let impl_m_span = tcx.sess.source_map().guess_head_span(impl_m_span);
42
43     if let Err(_) = compare_self_type(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref) {
44         return;
45     }
46
47     if let Err(_) = compare_number_of_generics(tcx, impl_m, impl_m_span, trait_m, trait_item_span) {
48         return;
49     }
50
51     if let Err(_) =
52         compare_number_of_method_arguments(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
53     {
54         return;
55     }
56
57     if let Err(_) = compare_synthetic_generics(tcx, impl_m, trait_m) {
58         return;
59     }
60
61     if let Err(_) = compare_predicate_entailment(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
62     {
63         return;
64     }
65
66     if let Err(_) = compare_const_param_types(tcx, impl_m, trait_m, trait_item_span) {
67         return;
68     }
69 }
70
71 fn compare_predicate_entailment<'tcx>(
72     tcx: TyCtxt<'tcx>,
73     impl_m: &ty::AssocItem,
74     impl_m_span: Span,
75     trait_m: &ty::AssocItem,
76     impl_trait_ref: ty::TraitRef<'tcx>,
77 ) -> Result<(), ErrorGuaranteed> {
78     let trait_to_impl_substs = impl_trait_ref.substs;
79
80     // This node-id should be used for the `body_id` field on each
81     // `ObligationCause` (and the `FnCtxt`). This is what
82     // `regionck_item` expects.
83     let impl_m_hir_id = tcx.hir().local_def_id_to_hir_id(impl_m.def_id.expect_local());
84
85     // We sometimes modify the span further down.
86     let mut cause = ObligationCause::new(
87         impl_m_span,
88         impl_m_hir_id,
89         ObligationCauseCode::CompareImplMethodObligation {
90             impl_item_def_id: impl_m.def_id.expect_local(),
91             trait_item_def_id: trait_m.def_id,
92         },
93     );
94
95     // This code is best explained by example. Consider a trait:
96     //
97     //     trait Trait<'t, T> {
98     //         fn method<'a, M>(t: &'t T, m: &'a M) -> Self;
99     //     }
100     //
101     // And an impl:
102     //
103     //     impl<'i, 'j, U> Trait<'j, &'i U> for Foo {
104     //          fn method<'b, N>(t: &'j &'i U, m: &'b N) -> Foo;
105     //     }
106     //
107     // We wish to decide if those two method types are compatible.
108     //
109     // We start out with trait_to_impl_substs, that maps the trait
110     // type parameters to impl type parameters. This is taken from the
111     // impl trait reference:
112     //
113     //     trait_to_impl_substs = {'t => 'j, T => &'i U, Self => Foo}
114     //
115     // We create a mapping `dummy_substs` that maps from the impl type
116     // parameters to fresh types and regions. For type parameters,
117     // this is the identity transform, but we could as well use any
118     // placeholder types. For regions, we convert from bound to free
119     // regions (Note: but only early-bound regions, i.e., those
120     // declared on the impl or used in type parameter bounds).
121     //
122     //     impl_to_placeholder_substs = {'i => 'i0, U => U0, N => N0 }
123     //
124     // Now we can apply placeholder_substs to the type of the impl method
125     // to yield a new function type in terms of our fresh, placeholder
126     // types:
127     //
128     //     <'b> fn(t: &'i0 U0, m: &'b) -> Foo
129     //
130     // We now want to extract and substitute the type of the *trait*
131     // method and compare it. To do so, we must create a compound
132     // substitution by combining trait_to_impl_substs and
133     // impl_to_placeholder_substs, and also adding a mapping for the method
134     // type parameters. We extend the mapping to also include
135     // the method parameters.
136     //
137     //     trait_to_placeholder_substs = { T => &'i0 U0, Self => Foo, M => N0 }
138     //
139     // Applying this to the trait method type yields:
140     //
141     //     <'a> fn(t: &'i0 U0, m: &'a) -> Foo
142     //
143     // This type is also the same but the name of the bound region ('a
144     // vs 'b).  However, the normal subtyping rules on fn types handle
145     // this kind of equivalency just fine.
146     //
147     // We now use these substitutions to ensure that all declared bounds are
148     // satisfied by the implementation's method.
149     //
150     // We do this by creating a parameter environment which contains a
151     // substitution corresponding to impl_to_placeholder_substs. We then build
152     // trait_to_placeholder_substs and use it to convert the predicates contained
153     // in the trait_m.generics to the placeholder form.
154     //
155     // Finally we register each of these predicates as an obligation in
156     // a fresh FulfillmentCtxt, and invoke select_all_or_error.
157
158     // Create mapping from impl to placeholder.
159     let impl_to_placeholder_substs = InternalSubsts::identity_for_item(tcx, impl_m.def_id);
160
161     // Create mapping from trait to placeholder.
162     let trait_to_placeholder_substs =
163         impl_to_placeholder_substs.rebase_onto(tcx, impl_m.container.id(), trait_to_impl_substs);
164     debug!("compare_impl_method: trait_to_placeholder_substs={:?}", trait_to_placeholder_substs);
165
166     let impl_m_generics = tcx.generics_of(impl_m.def_id);
167     let trait_m_generics = tcx.generics_of(trait_m.def_id);
168     let impl_m_predicates = tcx.predicates_of(impl_m.def_id);
169     let trait_m_predicates = tcx.predicates_of(trait_m.def_id);
170
171     // Check region bounds.
172     check_region_bounds_on_impl_item(
173         tcx,
174         impl_m_span,
175         impl_m,
176         trait_m,
177         &trait_m_generics,
178         &impl_m_generics,
179     )?;
180
181     // Create obligations for each predicate declared by the impl
182     // definition in the context of the trait's parameter
183     // environment. We can't just use `impl_env.caller_bounds`,
184     // however, because we want to replace all late-bound regions with
185     // region variables.
186     let impl_predicates = tcx.predicates_of(impl_m_predicates.parent.unwrap());
187     let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
188
189     debug!("compare_impl_method: impl_bounds={:?}", hybrid_preds);
190
191     // This is the only tricky bit of the new way we check implementation methods
192     // We need to build a set of predicates where only the method-level bounds
193     // are from the trait and we assume all other bounds from the implementation
194     // to be previously satisfied.
195     //
196     // We then register the obligations from the impl_m and check to see
197     // if all constraints hold.
198     hybrid_preds
199         .predicates
200         .extend(trait_m_predicates.instantiate_own(tcx, trait_to_placeholder_substs).predicates);
201
202     // Construct trait parameter environment and then shift it into the placeholder viewpoint.
203     // The key step here is to update the caller_bounds's predicates to be
204     // the new hybrid bounds we computed.
205     let normalize_cause = traits::ObligationCause::misc(impl_m_span, impl_m_hir_id);
206     let param_env = ty::ParamEnv::new(
207         tcx.intern_predicates(&hybrid_preds.predicates),
208         Reveal::UserFacing,
209         hir::Constness::NotConst,
210     );
211     let param_env =
212         traits::normalize_param_env_or_error(tcx, impl_m.def_id, param_env, normalize_cause);
213
214     tcx.infer_ctxt().enter(|infcx| {
215         let inh = Inherited::new(infcx, impl_m.def_id.expect_local());
216         let infcx = &inh.infcx;
217
218         debug!("compare_impl_method: caller_bounds={:?}", param_env.caller_bounds());
219
220         let mut selcx = traits::SelectionContext::new(&infcx);
221
222         let impl_m_own_bounds = impl_m_predicates.instantiate_own(tcx, impl_to_placeholder_substs);
223         for (predicate, span) in iter::zip(impl_m_own_bounds.predicates, impl_m_own_bounds.spans) {
224             let normalize_cause = traits::ObligationCause::misc(span, impl_m_hir_id);
225             let traits::Normalized { value: predicate, obligations } =
226                 traits::normalize(&mut selcx, param_env, normalize_cause, predicate);
227
228             inh.register_predicates(obligations);
229             let cause = ObligationCause::new(
230                 span,
231                 impl_m_hir_id,
232                 ObligationCauseCode::CompareImplMethodObligation {
233                     impl_item_def_id: impl_m.def_id.expect_local(),
234                     trait_item_def_id: trait_m.def_id,
235                 },
236             );
237             inh.register_predicate(traits::Obligation::new(cause, param_env, predicate));
238         }
239
240         // We now need to check that the signature of the impl method is
241         // compatible with that of the trait method. We do this by
242         // checking that `impl_fty <: trait_fty`.
243         //
244         // FIXME. Unfortunately, this doesn't quite work right now because
245         // associated type normalization is not integrated into subtype
246         // checks. For the comparison to be valid, we need to
247         // normalize the associated types in the impl/trait methods
248         // first. However, because function types bind regions, just
249         // calling `normalize_associated_types_in` would have no effect on
250         // any associated types appearing in the fn arguments or return
251         // type.
252
253         // Compute placeholder form of impl and trait method tys.
254         let tcx = infcx.tcx;
255
256         let mut wf_tys = FxHashSet::default();
257
258         let (impl_sig, _) = infcx.replace_bound_vars_with_fresh_vars(
259             impl_m_span,
260             infer::HigherRankedType,
261             tcx.fn_sig(impl_m.def_id),
262         );
263         let impl_sig =
264             inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, impl_sig);
265         let impl_fty = tcx.mk_fn_ptr(ty::Binder::dummy(impl_sig));
266         debug!("compare_impl_method: impl_fty={:?}", impl_fty);
267
268         // First liberate late bound regions and subst placeholders
269         let trait_sig = tcx.liberate_late_bound_regions(impl_m.def_id, tcx.fn_sig(trait_m.def_id));
270         let trait_sig = trait_sig.subst(tcx, trait_to_placeholder_substs);
271         let trait_sig =
272             inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, trait_sig);
273         // Add the resulting inputs and output as well-formed.
274         wf_tys.extend(trait_sig.inputs_and_output.iter());
275         let trait_fty = tcx.mk_fn_ptr(ty::Binder::dummy(trait_sig));
276
277         debug!("compare_impl_method: trait_fty={:?}", trait_fty);
278
279         let sub_result = infcx.at(&cause, param_env).sup(trait_fty, impl_fty).map(
280             |InferOk { obligations, .. }| {
281                 // FIXME: We'd want to keep more accurate spans than "the method signature" when
282                 // processing the comparison between the trait and impl fn, but we sadly lose them
283                 // and point at the whole signature when a trait bound or specific input or output
284                 // type would be more appropriate. In other places we have a `Vec<Span>`
285                 // corresponding to their `Vec<Predicate>`, but we don't have that here.
286                 // Fixing this would improve the output of test `issue-83765.rs`.
287                 inh.register_predicates(obligations);
288             },
289         );
290
291         if let Err(terr) = sub_result {
292             debug!("sub_types failed: impl ty {:?}, trait ty {:?}", impl_fty, trait_fty);
293
294             let (impl_err_span, trait_err_span) =
295                 extract_spans_for_error_reporting(&infcx, &terr, &cause, impl_m, trait_m);
296
297             cause.span = impl_err_span;
298
299             let mut diag = struct_span_err!(
300                 tcx.sess,
301                 cause.span(tcx),
302                 E0053,
303                 "method `{}` has an incompatible type for trait",
304                 trait_m.name
305             );
306             match &terr {
307                 TypeError::ArgumentMutability(0) | TypeError::ArgumentSorts(_, 0)
308                     if trait_m.fn_has_self_parameter =>
309                 {
310                     let ty = trait_sig.inputs()[0];
311                     let sugg = match ExplicitSelf::determine(ty, |_| ty == impl_trait_ref.self_ty())
312                     {
313                         ExplicitSelf::ByValue => "self".to_owned(),
314                         ExplicitSelf::ByReference(_, hir::Mutability::Not) => "&self".to_owned(),
315                         ExplicitSelf::ByReference(_, hir::Mutability::Mut) => {
316                             "&mut self".to_owned()
317                         }
318                         _ => format!("self: {ty}"),
319                     };
320
321                     // When the `impl` receiver is an arbitrary self type, like `self: Box<Self>`, the
322                     // span points only at the type `Box<Self`>, but we want to cover the whole
323                     // argument pattern and type.
324                     let span = match tcx.hir().expect_impl_item(impl_m.def_id.expect_local()).kind {
325                         ImplItemKind::Fn(ref sig, body) => tcx
326                             .hir()
327                             .body_param_names(body)
328                             .zip(sig.decl.inputs.iter())
329                             .map(|(param, ty)| param.span.to(ty.span))
330                             .next()
331                             .unwrap_or(impl_err_span),
332                         _ => bug!("{:?} is not a method", impl_m),
333                     };
334
335                     diag.span_suggestion(
336                         span,
337                         "change the self-receiver type to match the trait",
338                         sugg,
339                         Applicability::MachineApplicable,
340                     );
341                 }
342                 TypeError::ArgumentMutability(i) | TypeError::ArgumentSorts(_, i) => {
343                     if trait_sig.inputs().len() == *i {
344                         // Suggestion to change output type. We do not suggest in `async` functions
345                         // to avoid complex logic or incorrect output.
346                         match tcx.hir().expect_impl_item(impl_m.def_id.expect_local()).kind {
347                             ImplItemKind::Fn(ref sig, _)
348                                 if sig.header.asyncness == hir::IsAsync::NotAsync =>
349                             {
350                                 let msg = "change the output type to match the trait";
351                                 let ap = Applicability::MachineApplicable;
352                                 match sig.decl.output {
353                                     hir::FnRetTy::DefaultReturn(sp) => {
354                                         let sugg = format!("-> {} ", trait_sig.output());
355                                         diag.span_suggestion_verbose(sp, msg, sugg, ap);
356                                     }
357                                     hir::FnRetTy::Return(hir_ty) => {
358                                         let sugg = trait_sig.output().to_string();
359                                         diag.span_suggestion(hir_ty.span, msg, sugg, ap);
360                                     }
361                                 };
362                             }
363                             _ => {}
364                         };
365                     } else if let Some(trait_ty) = trait_sig.inputs().get(*i) {
366                         diag.span_suggestion(
367                             impl_err_span,
368                             "change the parameter type to match the trait",
369                             trait_ty.to_string(),
370                             Applicability::MachineApplicable,
371                         );
372                     }
373                 }
374                 _ => {}
375             }
376
377             infcx.note_type_err(
378                 &mut diag,
379                 &cause,
380                 trait_err_span.map(|sp| (sp, "type in trait".to_owned())),
381                 Some(infer::ValuePairs::Terms(ExpectedFound {
382                     expected: trait_fty.into(),
383                     found: impl_fty.into(),
384                 })),
385                 &terr,
386                 false,
387                 false,
388             );
389
390             return Err(diag.emit());
391         }
392
393         // Check that all obligations are satisfied by the implementation's
394         // version.
395         let errors = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx);
396         if !errors.is_empty() {
397             let reported = infcx.report_fulfillment_errors(&errors, None, false);
398             return Err(reported);
399         }
400
401         // Finally, resolve all regions. This catches wily misuses of
402         // lifetime parameters.
403         let fcx = FnCtxt::new(&inh, param_env, impl_m_hir_id);
404         fcx.regionck_item(impl_m_hir_id, impl_m_span, wf_tys);
405
406         Ok(())
407     })
408 }
409
410 fn check_region_bounds_on_impl_item<'tcx>(
411     tcx: TyCtxt<'tcx>,
412     span: Span,
413     impl_m: &ty::AssocItem,
414     trait_m: &ty::AssocItem,
415     trait_generics: &ty::Generics,
416     impl_generics: &ty::Generics,
417 ) -> Result<(), ErrorGuaranteed> {
418     let trait_params = trait_generics.own_counts().lifetimes;
419     let impl_params = impl_generics.own_counts().lifetimes;
420
421     debug!(
422         "check_region_bounds_on_impl_item: \
423             trait_generics={:?} \
424             impl_generics={:?}",
425         trait_generics, impl_generics
426     );
427
428     // Must have same number of early-bound lifetime parameters.
429     // Unfortunately, if the user screws up the bounds, then this
430     // will change classification between early and late.  E.g.,
431     // if in trait we have `<'a,'b:'a>`, and in impl we just have
432     // `<'a,'b>`, then we have 2 early-bound lifetime parameters
433     // in trait but 0 in the impl. But if we report "expected 2
434     // but found 0" it's confusing, because it looks like there
435     // are zero. Since I don't quite know how to phrase things at
436     // the moment, give a kind of vague error message.
437     if trait_params != impl_params {
438         let item_kind = assoc_item_kind_str(impl_m);
439         let def_span = tcx.sess.source_map().guess_head_span(span);
440         let span = impl_m
441             .def_id
442             .as_local()
443             .and_then(|did| tcx.hir().get_generics(did))
444             .map_or(def_span, |g| g.span);
445         let generics_span = tcx.hir().span_if_local(trait_m.def_id).map(|sp| {
446             let def_sp = tcx.sess.source_map().guess_head_span(sp);
447             trait_m
448                 .def_id
449                 .as_local()
450                 .and_then(|did| tcx.hir().get_generics(did))
451                 .map_or(def_sp, |g| g.span)
452         });
453
454         let reported = tcx.sess.emit_err(LifetimesOrBoundsMismatchOnTrait {
455             span,
456             item_kind,
457             ident: impl_m.ident(tcx),
458             generics_span,
459         });
460         return Err(reported);
461     }
462
463     Ok(())
464 }
465
466 #[instrument(level = "debug", skip(infcx))]
467 fn extract_spans_for_error_reporting<'a, 'tcx>(
468     infcx: &infer::InferCtxt<'a, 'tcx>,
469     terr: &TypeError<'_>,
470     cause: &ObligationCause<'tcx>,
471     impl_m: &ty::AssocItem,
472     trait_m: &ty::AssocItem,
473 ) -> (Span, Option<Span>) {
474     let tcx = infcx.tcx;
475     let mut impl_args = match tcx.hir().expect_impl_item(impl_m.def_id.expect_local()).kind {
476         ImplItemKind::Fn(ref sig, _) => {
477             sig.decl.inputs.iter().map(|t| t.span).chain(iter::once(sig.decl.output.span()))
478         }
479         _ => bug!("{:?} is not a method", impl_m),
480     };
481     let trait_args =
482         trait_m.def_id.as_local().map(|def_id| match tcx.hir().expect_trait_item(def_id).kind {
483             TraitItemKind::Fn(ref sig, _) => {
484                 sig.decl.inputs.iter().map(|t| t.span).chain(iter::once(sig.decl.output.span()))
485             }
486             _ => bug!("{:?} is not a TraitItemKind::Fn", trait_m),
487         });
488
489     match *terr {
490         TypeError::ArgumentMutability(i) => {
491             (impl_args.nth(i).unwrap(), trait_args.and_then(|mut args| args.nth(i)))
492         }
493         TypeError::ArgumentSorts(ExpectedFound { .. }, i) => {
494             (impl_args.nth(i).unwrap(), trait_args.and_then(|mut args| args.nth(i)))
495         }
496         _ => (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id)),
497     }
498 }
499
500 fn compare_self_type<'tcx>(
501     tcx: TyCtxt<'tcx>,
502     impl_m: &ty::AssocItem,
503     impl_m_span: Span,
504     trait_m: &ty::AssocItem,
505     impl_trait_ref: ty::TraitRef<'tcx>,
506 ) -> Result<(), ErrorGuaranteed> {
507     // Try to give more informative error messages about self typing
508     // mismatches.  Note that any mismatch will also be detected
509     // below, where we construct a canonical function type that
510     // includes the self parameter as a normal parameter.  It's just
511     // that the error messages you get out of this code are a bit more
512     // inscrutable, particularly for cases where one method has no
513     // self.
514
515     let self_string = |method: &ty::AssocItem| {
516         let untransformed_self_ty = match method.container {
517             ty::ImplContainer(_) => impl_trait_ref.self_ty(),
518             ty::TraitContainer(_) => tcx.types.self_param,
519         };
520         let self_arg_ty = tcx.fn_sig(method.def_id).input(0);
521         let param_env = ty::ParamEnv::reveal_all();
522
523         tcx.infer_ctxt().enter(|infcx| {
524             let self_arg_ty = tcx.liberate_late_bound_regions(method.def_id, self_arg_ty);
525             let can_eq_self = |ty| infcx.can_eq(param_env, untransformed_self_ty, ty).is_ok();
526             match ExplicitSelf::determine(self_arg_ty, can_eq_self) {
527                 ExplicitSelf::ByValue => "self".to_owned(),
528                 ExplicitSelf::ByReference(_, hir::Mutability::Not) => "&self".to_owned(),
529                 ExplicitSelf::ByReference(_, hir::Mutability::Mut) => "&mut self".to_owned(),
530                 _ => format!("self: {self_arg_ty}"),
531             }
532         })
533     };
534
535     match (trait_m.fn_has_self_parameter, impl_m.fn_has_self_parameter) {
536         (false, false) | (true, true) => {}
537
538         (false, true) => {
539             let self_descr = self_string(impl_m);
540             let mut err = struct_span_err!(
541                 tcx.sess,
542                 impl_m_span,
543                 E0185,
544                 "method `{}` has a `{}` declaration in the impl, but not in the trait",
545                 trait_m.name,
546                 self_descr
547             );
548             err.span_label(impl_m_span, format!("`{self_descr}` used in impl"));
549             if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
550                 err.span_label(span, format!("trait method declared without `{self_descr}`"));
551             } else {
552                 err.note_trait_signature(trait_m.name.to_string(), trait_m.signature(tcx));
553             }
554             let reported = err.emit();
555             return Err(reported);
556         }
557
558         (true, false) => {
559             let self_descr = self_string(trait_m);
560             let mut err = struct_span_err!(
561                 tcx.sess,
562                 impl_m_span,
563                 E0186,
564                 "method `{}` has a `{}` declaration in the trait, but not in the impl",
565                 trait_m.name,
566                 self_descr
567             );
568             err.span_label(impl_m_span, format!("expected `{self_descr}` in impl"));
569             if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
570                 err.span_label(span, format!("`{self_descr}` used in trait"));
571             } else {
572                 err.note_trait_signature(trait_m.name.to_string(), trait_m.signature(tcx));
573             }
574             let reported = err.emit();
575             return Err(reported);
576         }
577     }
578
579     Ok(())
580 }
581
582 fn compare_number_of_generics<'tcx>(
583     tcx: TyCtxt<'tcx>,
584     impl_: &ty::AssocItem,
585     _impl_span: Span,
586     trait_: &ty::AssocItem,
587     trait_span: Option<Span>,
588 ) -> Result<(), ErrorGuaranteed> {
589     let trait_own_counts = tcx.generics_of(trait_.def_id).own_counts();
590     let impl_own_counts = tcx.generics_of(impl_.def_id).own_counts();
591
592     let matchings = [
593         ("type", trait_own_counts.types, impl_own_counts.types),
594         ("const", trait_own_counts.consts, impl_own_counts.consts),
595     ];
596
597     let item_kind = assoc_item_kind_str(impl_);
598
599     let mut err_occurred = None;
600     for (kind, trait_count, impl_count) in matchings {
601         if impl_count != trait_count {
602             let (trait_spans, impl_trait_spans) = if let Some(def_id) = trait_.def_id.as_local() {
603                 let trait_item = tcx.hir().expect_trait_item(def_id);
604                 if trait_item.generics.params.is_empty() {
605                     (Some(vec![trait_item.generics.span]), vec![])
606                 } else {
607                     let arg_spans: Vec<Span> =
608                         trait_item.generics.params.iter().map(|p| p.span).collect();
609                     let impl_trait_spans: Vec<Span> = trait_item
610                         .generics
611                         .params
612                         .iter()
613                         .filter_map(|p| match p.kind {
614                             GenericParamKind::Type { synthetic: true, .. } => Some(p.span),
615                             _ => None,
616                         })
617                         .collect();
618                     (Some(arg_spans), impl_trait_spans)
619                 }
620             } else {
621                 (trait_span.map(|s| vec![s]), vec![])
622             };
623
624             let impl_item = tcx.hir().expect_impl_item(impl_.def_id.expect_local());
625             let impl_item_impl_trait_spans: Vec<Span> = impl_item
626                 .generics
627                 .params
628                 .iter()
629                 .filter_map(|p| match p.kind {
630                     GenericParamKind::Type { synthetic: true, .. } => Some(p.span),
631                     _ => None,
632                 })
633                 .collect();
634             let spans = impl_item.generics.spans();
635             let span = spans.primary_span();
636
637             let mut err = tcx.sess.struct_span_err_with_code(
638                 spans,
639                 &format!(
640                     "{} `{}` has {} {kind} parameter{} but its trait \
641                      declaration has {} {kind} parameter{}",
642                     item_kind,
643                     trait_.name,
644                     impl_count,
645                     pluralize!(impl_count),
646                     trait_count,
647                     pluralize!(trait_count),
648                     kind = kind,
649                 ),
650                 DiagnosticId::Error("E0049".into()),
651             );
652
653             let mut suffix = None;
654
655             if let Some(spans) = trait_spans {
656                 let mut spans = spans.iter();
657                 if let Some(span) = spans.next() {
658                     err.span_label(
659                         *span,
660                         format!(
661                             "expected {} {} parameter{}",
662                             trait_count,
663                             kind,
664                             pluralize!(trait_count),
665                         ),
666                     );
667                 }
668                 for span in spans {
669                     err.span_label(*span, "");
670                 }
671             } else {
672                 suffix = Some(format!(", expected {trait_count}"));
673             }
674
675             if let Some(span) = span {
676                 err.span_label(
677                     span,
678                     format!(
679                         "found {} {} parameter{}{}",
680                         impl_count,
681                         kind,
682                         pluralize!(impl_count),
683                         suffix.unwrap_or_else(String::new),
684                     ),
685                 );
686             }
687
688             for span in impl_trait_spans.iter().chain(impl_item_impl_trait_spans.iter()) {
689                 err.span_label(*span, "`impl Trait` introduces an implicit type parameter");
690             }
691
692             let reported = err.emit();
693             err_occurred = Some(reported);
694         }
695     }
696
697     if let Some(reported) = err_occurred { Err(reported) } else { Ok(()) }
698 }
699
700 fn compare_number_of_method_arguments<'tcx>(
701     tcx: TyCtxt<'tcx>,
702     impl_m: &ty::AssocItem,
703     impl_m_span: Span,
704     trait_m: &ty::AssocItem,
705     trait_item_span: Option<Span>,
706 ) -> Result<(), ErrorGuaranteed> {
707     let impl_m_fty = tcx.fn_sig(impl_m.def_id);
708     let trait_m_fty = tcx.fn_sig(trait_m.def_id);
709     let trait_number_args = trait_m_fty.inputs().skip_binder().len();
710     let impl_number_args = impl_m_fty.inputs().skip_binder().len();
711     if trait_number_args != impl_number_args {
712         let trait_span = if let Some(def_id) = trait_m.def_id.as_local() {
713             match tcx.hir().expect_trait_item(def_id).kind {
714                 TraitItemKind::Fn(ref trait_m_sig, _) => {
715                     let pos = if trait_number_args > 0 { trait_number_args - 1 } else { 0 };
716                     if let Some(arg) = trait_m_sig.decl.inputs.get(pos) {
717                         Some(if pos == 0 {
718                             arg.span
719                         } else {
720                             arg.span.with_lo(trait_m_sig.decl.inputs[0].span.lo())
721                         })
722                     } else {
723                         trait_item_span
724                     }
725                 }
726                 _ => bug!("{:?} is not a method", impl_m),
727             }
728         } else {
729             trait_item_span
730         };
731         let impl_span = match tcx.hir().expect_impl_item(impl_m.def_id.expect_local()).kind {
732             ImplItemKind::Fn(ref impl_m_sig, _) => {
733                 let pos = if impl_number_args > 0 { impl_number_args - 1 } else { 0 };
734                 if let Some(arg) = impl_m_sig.decl.inputs.get(pos) {
735                     if pos == 0 {
736                         arg.span
737                     } else {
738                         arg.span.with_lo(impl_m_sig.decl.inputs[0].span.lo())
739                     }
740                 } else {
741                     impl_m_span
742                 }
743             }
744             _ => bug!("{:?} is not a method", impl_m),
745         };
746         let mut err = struct_span_err!(
747             tcx.sess,
748             impl_span,
749             E0050,
750             "method `{}` has {} but the declaration in trait `{}` has {}",
751             trait_m.name,
752             potentially_plural_count(impl_number_args, "parameter"),
753             tcx.def_path_str(trait_m.def_id),
754             trait_number_args
755         );
756         if let Some(trait_span) = trait_span {
757             err.span_label(
758                 trait_span,
759                 format!(
760                     "trait requires {}",
761                     potentially_plural_count(trait_number_args, "parameter")
762                 ),
763             );
764         } else {
765             err.note_trait_signature(trait_m.name.to_string(), trait_m.signature(tcx));
766         }
767         err.span_label(
768             impl_span,
769             format!(
770                 "expected {}, found {}",
771                 potentially_plural_count(trait_number_args, "parameter"),
772                 impl_number_args
773             ),
774         );
775         let reported = err.emit();
776         return Err(reported);
777     }
778
779     Ok(())
780 }
781
782 fn compare_synthetic_generics<'tcx>(
783     tcx: TyCtxt<'tcx>,
784     impl_m: &ty::AssocItem,
785     trait_m: &ty::AssocItem,
786 ) -> Result<(), ErrorGuaranteed> {
787     // FIXME(chrisvittal) Clean up this function, list of FIXME items:
788     //     1. Better messages for the span labels
789     //     2. Explanation as to what is going on
790     // If we get here, we already have the same number of generics, so the zip will
791     // be okay.
792     let mut error_found = None;
793     let impl_m_generics = tcx.generics_of(impl_m.def_id);
794     let trait_m_generics = tcx.generics_of(trait_m.def_id);
795     let impl_m_type_params = impl_m_generics.params.iter().filter_map(|param| match param.kind {
796         GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
797         GenericParamDefKind::Lifetime | GenericParamDefKind::Const { .. } => None,
798     });
799     let trait_m_type_params = trait_m_generics.params.iter().filter_map(|param| match param.kind {
800         GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
801         GenericParamDefKind::Lifetime | GenericParamDefKind::Const { .. } => None,
802     });
803     for ((impl_def_id, impl_synthetic), (trait_def_id, trait_synthetic)) in
804         iter::zip(impl_m_type_params, trait_m_type_params)
805     {
806         if impl_synthetic != trait_synthetic {
807             let impl_def_id = impl_def_id.expect_local();
808             let impl_hir_id = tcx.hir().local_def_id_to_hir_id(impl_def_id);
809             let impl_span = tcx.hir().span(impl_hir_id);
810             let trait_span = tcx.def_span(trait_def_id);
811             let mut err = struct_span_err!(
812                 tcx.sess,
813                 impl_span,
814                 E0643,
815                 "method `{}` has incompatible signature for trait",
816                 trait_m.name
817             );
818             err.span_label(trait_span, "declaration in trait here");
819             match (impl_synthetic, trait_synthetic) {
820                 // The case where the impl method uses `impl Trait` but the trait method uses
821                 // explicit generics
822                 (true, false) => {
823                     err.span_label(impl_span, "expected generic parameter, found `impl Trait`");
824                     (|| {
825                         // try taking the name from the trait impl
826                         // FIXME: this is obviously suboptimal since the name can already be used
827                         // as another generic argument
828                         let new_name = tcx.sess.source_map().span_to_snippet(trait_span).ok()?;
829                         let trait_m = trait_m.def_id.as_local()?;
830                         let trait_m = tcx.hir().trait_item(hir::TraitItemId { def_id: trait_m });
831
832                         let impl_m = impl_m.def_id.as_local()?;
833                         let impl_m = tcx.hir().impl_item(hir::ImplItemId { def_id: impl_m });
834
835                         // in case there are no generics, take the spot between the function name
836                         // and the opening paren of the argument list
837                         let new_generics_span =
838                             tcx.sess.source_map().generate_fn_name_span(impl_span)?.shrink_to_hi();
839                         // in case there are generics, just replace them
840                         let generics_span =
841                             impl_m.generics.span.substitute_dummy(new_generics_span);
842                         // replace with the generics from the trait
843                         let new_generics =
844                             tcx.sess.source_map().span_to_snippet(trait_m.generics.span).ok()?;
845
846                         err.multipart_suggestion(
847                             "try changing the `impl Trait` argument to a generic parameter",
848                             vec![
849                                 // replace `impl Trait` with `T`
850                                 (impl_span, new_name),
851                                 // replace impl method generics with trait method generics
852                                 // This isn't quite right, as users might have changed the names
853                                 // of the generics, but it works for the common case
854                                 (generics_span, new_generics),
855                             ],
856                             Applicability::MaybeIncorrect,
857                         );
858                         Some(())
859                     })();
860                 }
861                 // The case where the trait method uses `impl Trait`, but the impl method uses
862                 // explicit generics.
863                 (false, true) => {
864                     err.span_label(impl_span, "expected `impl Trait`, found generic parameter");
865                     (|| {
866                         let impl_m = impl_m.def_id.as_local()?;
867                         let impl_m = tcx.hir().impl_item(hir::ImplItemId { def_id: impl_m });
868                         let input_tys = match impl_m.kind {
869                             hir::ImplItemKind::Fn(ref sig, _) => sig.decl.inputs,
870                             _ => unreachable!(),
871                         };
872                         struct Visitor(Option<Span>, hir::def_id::LocalDefId);
873                         impl<'v> intravisit::Visitor<'v> for Visitor {
874                             fn visit_ty(&mut self, ty: &'v hir::Ty<'v>) {
875                                 intravisit::walk_ty(self, ty);
876                                 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) =
877                                     ty.kind
878                                     && let Res::Def(DefKind::TyParam, def_id) = path.res
879                                     && def_id == self.1.to_def_id()
880                                 {
881                                     self.0 = Some(ty.span);
882                                 }
883                             }
884                         }
885                         let mut visitor = Visitor(None, impl_def_id);
886                         for ty in input_tys {
887                             intravisit::Visitor::visit_ty(&mut visitor, ty);
888                         }
889                         let span = visitor.0?;
890
891                         let bounds = impl_m.generics.bounds_for_param(impl_def_id).next()?.bounds;
892                         let bounds = bounds.first()?.span().to(bounds.last()?.span());
893                         let bounds = tcx.sess.source_map().span_to_snippet(bounds).ok()?;
894
895                         err.multipart_suggestion(
896                             "try removing the generic parameter and using `impl Trait` instead",
897                             vec![
898                                 // delete generic parameters
899                                 (impl_m.generics.span, String::new()),
900                                 // replace param usage with `impl Trait`
901                                 (span, format!("impl {bounds}")),
902                             ],
903                             Applicability::MaybeIncorrect,
904                         );
905                         Some(())
906                     })();
907                 }
908                 _ => unreachable!(),
909             }
910             let reported = err.emit();
911             error_found = Some(reported);
912         }
913     }
914     if let Some(reported) = error_found { Err(reported) } else { Ok(()) }
915 }
916
917 fn compare_const_param_types<'tcx>(
918     tcx: TyCtxt<'tcx>,
919     impl_m: &ty::AssocItem,
920     trait_m: &ty::AssocItem,
921     trait_item_span: Option<Span>,
922 ) -> Result<(), ErrorGuaranteed> {
923     let const_params_of = |def_id| {
924         tcx.generics_of(def_id).params.iter().filter_map(|param| match param.kind {
925             GenericParamDefKind::Const { .. } => Some(param.def_id),
926             _ => None,
927         })
928     };
929     let const_params_impl = const_params_of(impl_m.def_id);
930     let const_params_trait = const_params_of(trait_m.def_id);
931
932     for (const_param_impl, const_param_trait) in iter::zip(const_params_impl, const_params_trait) {
933         let impl_ty = tcx.type_of(const_param_impl);
934         let trait_ty = tcx.type_of(const_param_trait);
935         if impl_ty != trait_ty {
936             let (impl_span, impl_ident) = match tcx.hir().get_if_local(const_param_impl) {
937                 Some(hir::Node::GenericParam(hir::GenericParam { span, name, .. })) => (
938                     span,
939                     match name {
940                         hir::ParamName::Plain(ident) => Some(ident),
941                         _ => None,
942                     },
943                 ),
944                 other => bug!(
945                     "expected GenericParam, found {:?}",
946                     other.map_or_else(|| "nothing".to_string(), |n| format!("{:?}", n))
947                 ),
948             };
949             let trait_span = match tcx.hir().get_if_local(const_param_trait) {
950                 Some(hir::Node::GenericParam(hir::GenericParam { span, .. })) => Some(span),
951                 _ => None,
952             };
953             let mut err = struct_span_err!(
954                 tcx.sess,
955                 *impl_span,
956                 E0053,
957                 "method `{}` has an incompatible const parameter type for trait",
958                 trait_m.name
959             );
960             err.span_note(
961                 trait_span.map_or_else(|| trait_item_span.unwrap_or(*impl_span), |span| *span),
962                 &format!(
963                     "the const parameter{} has type `{}`, but the declaration \
964                               in trait `{}` has type `{}`",
965                     &impl_ident.map_or_else(|| "".to_string(), |ident| format!(" `{ident}`")),
966                     impl_ty,
967                     tcx.def_path_str(trait_m.def_id),
968                     trait_ty
969                 ),
970             );
971             let reported = err.emit();
972             return Err(reported);
973         }
974     }
975
976     Ok(())
977 }
978
979 crate fn compare_const_impl<'tcx>(
980     tcx: TyCtxt<'tcx>,
981     impl_c: &ty::AssocItem,
982     impl_c_span: Span,
983     trait_c: &ty::AssocItem,
984     impl_trait_ref: ty::TraitRef<'tcx>,
985 ) {
986     debug!("compare_const_impl(impl_trait_ref={:?})", impl_trait_ref);
987
988     tcx.infer_ctxt().enter(|infcx| {
989         let param_env = tcx.param_env(impl_c.def_id);
990         let inh = Inherited::new(infcx, impl_c.def_id.expect_local());
991         let infcx = &inh.infcx;
992
993         // The below is for the most part highly similar to the procedure
994         // for methods above. It is simpler in many respects, especially
995         // because we shouldn't really have to deal with lifetimes or
996         // predicates. In fact some of this should probably be put into
997         // shared functions because of DRY violations...
998         let trait_to_impl_substs = impl_trait_ref.substs;
999
1000         // Create a parameter environment that represents the implementation's
1001         // method.
1002         let impl_c_hir_id = tcx.hir().local_def_id_to_hir_id(impl_c.def_id.expect_local());
1003
1004         // Compute placeholder form of impl and trait const tys.
1005         let impl_ty = tcx.type_of(impl_c.def_id);
1006         let trait_ty = tcx.type_of(trait_c.def_id).subst(tcx, trait_to_impl_substs);
1007         let mut cause = ObligationCause::new(
1008             impl_c_span,
1009             impl_c_hir_id,
1010             ObligationCauseCode::CompareImplConstObligation,
1011         );
1012
1013         // There is no "body" here, so just pass dummy id.
1014         let impl_ty =
1015             inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, impl_ty);
1016
1017         debug!("compare_const_impl: impl_ty={:?}", impl_ty);
1018
1019         let trait_ty =
1020             inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, trait_ty);
1021
1022         debug!("compare_const_impl: trait_ty={:?}", trait_ty);
1023
1024         let err = infcx
1025             .at(&cause, param_env)
1026             .sup(trait_ty, impl_ty)
1027             .map(|ok| inh.register_infer_ok_obligations(ok));
1028
1029         if let Err(terr) = err {
1030             debug!(
1031                 "checking associated const for compatibility: impl ty {:?}, trait ty {:?}",
1032                 impl_ty, trait_ty
1033             );
1034
1035             // Locate the Span containing just the type of the offending impl
1036             match tcx.hir().expect_impl_item(impl_c.def_id.expect_local()).kind {
1037                 ImplItemKind::Const(ref ty, _) => cause.span = ty.span,
1038                 _ => bug!("{:?} is not a impl const", impl_c),
1039             }
1040
1041             let mut diag = struct_span_err!(
1042                 tcx.sess,
1043                 cause.span,
1044                 E0326,
1045                 "implemented const `{}` has an incompatible type for trait",
1046                 trait_c.name
1047             );
1048
1049             let trait_c_span = trait_c.def_id.as_local().map(|trait_c_def_id| {
1050                 // Add a label to the Span containing just the type of the const
1051                 match tcx.hir().expect_trait_item(trait_c_def_id).kind {
1052                     TraitItemKind::Const(ref ty, _) => ty.span,
1053                     _ => bug!("{:?} is not a trait const", trait_c),
1054                 }
1055             });
1056
1057             infcx.note_type_err(
1058                 &mut diag,
1059                 &cause,
1060                 trait_c_span.map(|span| (span, "type in trait".to_owned())),
1061                 Some(infer::ValuePairs::Terms(ExpectedFound {
1062                     expected: trait_ty.into(),
1063                     found: impl_ty.into(),
1064                 })),
1065                 &terr,
1066                 false,
1067                 false,
1068             );
1069             diag.emit();
1070         }
1071
1072         // Check that all obligations are satisfied by the implementation's
1073         // version.
1074         let errors = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx);
1075         if !errors.is_empty() {
1076             infcx.report_fulfillment_errors(&errors, None, false);
1077             return;
1078         }
1079
1080         let fcx = FnCtxt::new(&inh, param_env, impl_c_hir_id);
1081         fcx.regionck_item(impl_c_hir_id, impl_c_span, FxHashSet::default());
1082     });
1083 }
1084
1085 crate fn compare_ty_impl<'tcx>(
1086     tcx: TyCtxt<'tcx>,
1087     impl_ty: &ty::AssocItem,
1088     impl_ty_span: Span,
1089     trait_ty: &ty::AssocItem,
1090     impl_trait_ref: ty::TraitRef<'tcx>,
1091     trait_item_span: Option<Span>,
1092 ) {
1093     debug!("compare_impl_type(impl_trait_ref={:?})", impl_trait_ref);
1094
1095     let _: Result<(), ErrorGuaranteed> = (|| {
1096         compare_number_of_generics(tcx, impl_ty, impl_ty_span, trait_ty, trait_item_span)?;
1097
1098         let sp = tcx.def_span(impl_ty.def_id);
1099         compare_type_predicate_entailment(tcx, impl_ty, sp, trait_ty, impl_trait_ref)?;
1100
1101         check_type_bounds(tcx, trait_ty, impl_ty, impl_ty_span, impl_trait_ref)
1102     })();
1103 }
1104
1105 /// The equivalent of [compare_predicate_entailment], but for associated types
1106 /// instead of associated functions.
1107 fn compare_type_predicate_entailment<'tcx>(
1108     tcx: TyCtxt<'tcx>,
1109     impl_ty: &ty::AssocItem,
1110     impl_ty_span: Span,
1111     trait_ty: &ty::AssocItem,
1112     impl_trait_ref: ty::TraitRef<'tcx>,
1113 ) -> Result<(), ErrorGuaranteed> {
1114     let impl_substs = InternalSubsts::identity_for_item(tcx, impl_ty.def_id);
1115     let trait_to_impl_substs =
1116         impl_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1117
1118     let impl_ty_generics = tcx.generics_of(impl_ty.def_id);
1119     let trait_ty_generics = tcx.generics_of(trait_ty.def_id);
1120     let impl_ty_predicates = tcx.predicates_of(impl_ty.def_id);
1121     let trait_ty_predicates = tcx.predicates_of(trait_ty.def_id);
1122
1123     check_region_bounds_on_impl_item(
1124         tcx,
1125         impl_ty_span,
1126         impl_ty,
1127         trait_ty,
1128         &trait_ty_generics,
1129         &impl_ty_generics,
1130     )?;
1131
1132     let impl_ty_own_bounds = impl_ty_predicates.instantiate_own(tcx, impl_substs);
1133
1134     if impl_ty_own_bounds.is_empty() {
1135         // Nothing to check.
1136         return Ok(());
1137     }
1138
1139     // This `HirId` should be used for the `body_id` field on each
1140     // `ObligationCause` (and the `FnCtxt`). This is what
1141     // `regionck_item` expects.
1142     let impl_ty_hir_id = tcx.hir().local_def_id_to_hir_id(impl_ty.def_id.expect_local());
1143     let cause = ObligationCause::new(
1144         impl_ty_span,
1145         impl_ty_hir_id,
1146         ObligationCauseCode::CompareImplTypeObligation {
1147             impl_item_def_id: impl_ty.def_id.expect_local(),
1148             trait_item_def_id: trait_ty.def_id,
1149         },
1150     );
1151
1152     debug!("compare_type_predicate_entailment: trait_to_impl_substs={:?}", trait_to_impl_substs);
1153
1154     // The predicates declared by the impl definition, the trait and the
1155     // associated type in the trait are assumed.
1156     let impl_predicates = tcx.predicates_of(impl_ty_predicates.parent.unwrap());
1157     let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
1158     hybrid_preds
1159         .predicates
1160         .extend(trait_ty_predicates.instantiate_own(tcx, trait_to_impl_substs).predicates);
1161
1162     debug!("compare_type_predicate_entailment: bounds={:?}", hybrid_preds);
1163
1164     let normalize_cause = traits::ObligationCause::misc(impl_ty_span, impl_ty_hir_id);
1165     let param_env = ty::ParamEnv::new(
1166         tcx.intern_predicates(&hybrid_preds.predicates),
1167         Reveal::UserFacing,
1168         hir::Constness::NotConst,
1169     );
1170     let param_env = traits::normalize_param_env_or_error(
1171         tcx,
1172         impl_ty.def_id,
1173         param_env,
1174         normalize_cause.clone(),
1175     );
1176     tcx.infer_ctxt().enter(|infcx| {
1177         let inh = Inherited::new(infcx, impl_ty.def_id.expect_local());
1178         let infcx = &inh.infcx;
1179
1180         debug!("compare_type_predicate_entailment: caller_bounds={:?}", param_env.caller_bounds());
1181
1182         let mut selcx = traits::SelectionContext::new(&infcx);
1183
1184         for predicate in impl_ty_own_bounds.predicates {
1185             let traits::Normalized { value: predicate, obligations } =
1186                 traits::normalize(&mut selcx, param_env, normalize_cause.clone(), predicate);
1187
1188             inh.register_predicates(obligations);
1189             inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
1190         }
1191
1192         // Check that all obligations are satisfied by the implementation's
1193         // version.
1194         let errors = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx);
1195         if !errors.is_empty() {
1196             let reported = infcx.report_fulfillment_errors(&errors, None, false);
1197             return Err(reported);
1198         }
1199
1200         // Finally, resolve all regions. This catches wily misuses of
1201         // lifetime parameters.
1202         let fcx = FnCtxt::new(&inh, param_env, impl_ty_hir_id);
1203         fcx.regionck_item(impl_ty_hir_id, impl_ty_span, FxHashSet::default());
1204
1205         Ok(())
1206     })
1207 }
1208
1209 /// Validate that `ProjectionCandidate`s created for this associated type will
1210 /// be valid.
1211 ///
1212 /// Usually given
1213 ///
1214 /// trait X { type Y: Copy } impl X for T { type Y = S; }
1215 ///
1216 /// We are able to normalize `<T as X>::U` to `S`, and so when we check the
1217 /// impl is well-formed we have to prove `S: Copy`.
1218 ///
1219 /// For default associated types the normalization is not possible (the value
1220 /// from the impl could be overridden). We also can't normalize generic
1221 /// associated types (yet) because they contain bound parameters.
1222 #[tracing::instrument(level = "debug", skip(tcx))]
1223 pub fn check_type_bounds<'tcx>(
1224     tcx: TyCtxt<'tcx>,
1225     trait_ty: &ty::AssocItem,
1226     impl_ty: &ty::AssocItem,
1227     impl_ty_span: Span,
1228     impl_trait_ref: ty::TraitRef<'tcx>,
1229 ) -> Result<(), ErrorGuaranteed> {
1230     // Given
1231     //
1232     // impl<A, B> Foo<u32> for (A, B) {
1233     //     type Bar<C> =...
1234     // }
1235     //
1236     // - `impl_trait_ref` would be `<(A, B) as Foo<u32>>
1237     // - `impl_ty_substs` would be `[A, B, ^0.0]` (`^0.0` here is the bound var with db 0 and index 0)
1238     // - `rebased_substs` would be `[(A, B), u32, ^0.0]`, combining the substs from
1239     //    the *trait* with the generic associated type parameters (as bound vars).
1240     //
1241     // A note regarding the use of bound vars here:
1242     // Imagine as an example
1243     // ```
1244     // trait Family {
1245     //     type Member<C: Eq>;
1246     // }
1247     //
1248     // impl Family for VecFamily {
1249     //     type Member<C: Eq> = i32;
1250     // }
1251     // ```
1252     // Here, we would generate
1253     // ```notrust
1254     // forall<C> { Normalize(<VecFamily as Family>::Member<C> => i32) }
1255     // ```
1256     // when we really would like to generate
1257     // ```notrust
1258     // forall<C> { Normalize(<VecFamily as Family>::Member<C> => i32) :- Implemented(C: Eq) }
1259     // ```
1260     // But, this is probably fine, because although the first clause can be used with types C that
1261     // do not implement Eq, for it to cause some kind of problem, there would have to be a
1262     // VecFamily::Member<X> for some type X where !(X: Eq), that appears in the value of type
1263     // Member<C: Eq> = .... That type would fail a well-formedness check that we ought to be doing
1264     // elsewhere, which would check that any <T as Family>::Member<X> meets the bounds declared in
1265     // the trait (notably, that X: Eq and T: Family).
1266     let defs: &ty::Generics = tcx.generics_of(impl_ty.def_id);
1267     let mut substs = smallvec::SmallVec::with_capacity(defs.count());
1268     if let Some(def_id) = defs.parent {
1269         let parent_defs = tcx.generics_of(def_id);
1270         InternalSubsts::fill_item(&mut substs, tcx, parent_defs, &mut |param, _| {
1271             tcx.mk_param_from_def(param)
1272         });
1273     }
1274     let mut bound_vars: smallvec::SmallVec<[ty::BoundVariableKind; 8]> =
1275         smallvec::SmallVec::with_capacity(defs.count());
1276     InternalSubsts::fill_single(&mut substs, defs, &mut |param, _| match param.kind {
1277         GenericParamDefKind::Type { .. } => {
1278             let kind = ty::BoundTyKind::Param(param.name);
1279             let bound_var = ty::BoundVariableKind::Ty(kind);
1280             bound_vars.push(bound_var);
1281             tcx.mk_ty(ty::Bound(
1282                 ty::INNERMOST,
1283                 ty::BoundTy { var: ty::BoundVar::from_usize(bound_vars.len() - 1), kind },
1284             ))
1285             .into()
1286         }
1287         GenericParamDefKind::Lifetime => {
1288             let kind = ty::BoundRegionKind::BrNamed(param.def_id, param.name);
1289             let bound_var = ty::BoundVariableKind::Region(kind);
1290             bound_vars.push(bound_var);
1291             tcx.mk_region(ty::ReLateBound(
1292                 ty::INNERMOST,
1293                 ty::BoundRegion { var: ty::BoundVar::from_usize(bound_vars.len() - 1), kind },
1294             ))
1295             .into()
1296         }
1297         GenericParamDefKind::Const { .. } => {
1298             let bound_var = ty::BoundVariableKind::Const;
1299             bound_vars.push(bound_var);
1300             tcx.mk_const(ty::ConstS {
1301                 ty: tcx.type_of(param.def_id),
1302                 val: ty::ConstKind::Bound(
1303                     ty::INNERMOST,
1304                     ty::BoundVar::from_usize(bound_vars.len() - 1),
1305                 ),
1306             })
1307             .into()
1308         }
1309     });
1310     let bound_vars = tcx.mk_bound_variable_kinds(bound_vars.into_iter());
1311     let impl_ty_substs = tcx.intern_substs(&substs);
1312
1313     let rebased_substs =
1314         impl_ty_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1315     let impl_ty_value = tcx.type_of(impl_ty.def_id);
1316
1317     let param_env = tcx.param_env(impl_ty.def_id);
1318
1319     // When checking something like
1320     //
1321     // trait X { type Y: PartialEq<<Self as X>::Y> }
1322     // impl X for T { default type Y = S; }
1323     //
1324     // We will have to prove the bound S: PartialEq<<T as X>::Y>. In this case
1325     // we want <T as X>::Y to normalize to S. This is valid because we are
1326     // checking the default value specifically here. Add this equality to the
1327     // ParamEnv for normalization specifically.
1328     let normalize_param_env = {
1329         let mut predicates = param_env.caller_bounds().iter().collect::<Vec<_>>();
1330         match impl_ty_value.kind() {
1331             ty::Projection(proj)
1332                 if proj.item_def_id == trait_ty.def_id && proj.substs == rebased_substs =>
1333             {
1334                 // Don't include this predicate if the projected type is
1335                 // exactly the same as the projection. This can occur in
1336                 // (somewhat dubious) code like this:
1337                 //
1338                 // impl<T> X for T where T: X { type Y = <T as X>::Y; }
1339             }
1340             _ => predicates.push(
1341                 ty::Binder::bind_with_vars(
1342                     ty::ProjectionPredicate {
1343                         projection_ty: ty::ProjectionTy {
1344                             item_def_id: trait_ty.def_id,
1345                             substs: rebased_substs,
1346                         },
1347                         term: impl_ty_value.into(),
1348                     },
1349                     bound_vars,
1350                 )
1351                 .to_predicate(tcx),
1352             ),
1353         };
1354         ty::ParamEnv::new(
1355             tcx.intern_predicates(&predicates),
1356             Reveal::UserFacing,
1357             param_env.constness(),
1358         )
1359     };
1360     debug!(?normalize_param_env);
1361
1362     let impl_ty_substs = InternalSubsts::identity_for_item(tcx, impl_ty.def_id);
1363     let rebased_substs =
1364         impl_ty_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1365
1366     tcx.infer_ctxt().enter(move |infcx| {
1367         let inh = Inherited::new(infcx, impl_ty.def_id.expect_local());
1368         let infcx = &inh.infcx;
1369         let mut selcx = traits::SelectionContext::new(&infcx);
1370
1371         let impl_ty_hir_id = tcx.hir().local_def_id_to_hir_id(impl_ty.def_id.expect_local());
1372         let normalize_cause = ObligationCause::new(
1373             impl_ty_span,
1374             impl_ty_hir_id,
1375             ObligationCauseCode::CheckAssociatedTypeBounds {
1376                 impl_item_def_id: impl_ty.def_id.expect_local(),
1377                 trait_item_def_id: trait_ty.def_id,
1378             },
1379         );
1380         let mk_cause = |span: Span| {
1381             let code = if span.is_dummy() {
1382                 traits::MiscObligation
1383             } else {
1384                 traits::BindingObligation(trait_ty.def_id, span)
1385             };
1386             ObligationCause::new(impl_ty_span, impl_ty_hir_id, code)
1387         };
1388
1389         let obligations = tcx
1390             .explicit_item_bounds(trait_ty.def_id)
1391             .iter()
1392             .map(|&(bound, span)| {
1393                 debug!(?bound);
1394                 let concrete_ty_bound = bound.subst(tcx, rebased_substs);
1395                 debug!("check_type_bounds: concrete_ty_bound = {:?}", concrete_ty_bound);
1396
1397                 traits::Obligation::new(mk_cause(span), param_env, concrete_ty_bound)
1398             })
1399             .collect();
1400         debug!("check_type_bounds: item_bounds={:?}", obligations);
1401
1402         for mut obligation in util::elaborate_obligations(tcx, obligations) {
1403             let traits::Normalized { value: normalized_predicate, obligations } = traits::normalize(
1404                 &mut selcx,
1405                 normalize_param_env,
1406                 normalize_cause.clone(),
1407                 obligation.predicate,
1408             );
1409             debug!("compare_projection_bounds: normalized predicate = {:?}", normalized_predicate);
1410             obligation.predicate = normalized_predicate;
1411
1412             inh.register_predicates(obligations);
1413             inh.register_predicate(obligation);
1414         }
1415
1416         // Check that all obligations are satisfied by the implementation's
1417         // version.
1418         let errors = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx);
1419         if !errors.is_empty() {
1420             let reported = infcx.report_fulfillment_errors(&errors, None, false);
1421             return Err(reported);
1422         }
1423
1424         // Finally, resolve all regions. This catches wily misuses of
1425         // lifetime parameters.
1426         let fcx = FnCtxt::new(&inh, param_env, impl_ty_hir_id);
1427         let implied_bounds = match impl_ty.container {
1428             ty::TraitContainer(_) => FxHashSet::default(),
1429             ty::ImplContainer(def_id) => fcx.impl_implied_bounds(def_id, impl_ty_span),
1430         };
1431         fcx.regionck_item(impl_ty_hir_id, impl_ty_span, implied_bounds);
1432
1433         Ok(())
1434     })
1435 }
1436
1437 fn assoc_item_kind_str(impl_item: &ty::AssocItem) -> &'static str {
1438     match impl_item.kind {
1439         ty::AssocKind::Const => "const",
1440         ty::AssocKind::Fn => "method",
1441         ty::AssocKind::Type => "type",
1442     }
1443 }