1 use errors::{pluralize, struct_span_err, Applicability, DiagnosticId};
2 use rustc::hir::intravisit;
3 use rustc::infer::{self, InferOk};
4 use rustc::traits::{self, ObligationCause, ObligationCauseCode, Reveal};
5 use rustc::ty::error::{ExpectedFound, TypeError};
6 use rustc::ty::subst::{InternalSubsts, Subst};
7 use rustc::ty::util::ExplicitSelf;
8 use rustc::ty::{self, GenericParamDefKind, TyCtxt};
9 use rustc::util::common::ErrorReported;
11 use rustc_hir::def::{DefKind, Res};
12 use rustc_hir::{GenericParamKind, ImplItemKind, TraitItemKind};
15 use super::{potentially_plural_count, FnCtxt, Inherited};
17 use rustc_error_codes::*;
19 /// Checks that a method from an impl conforms to the signature of
20 /// the same method as declared in the trait.
24 /// - `impl_m`: type of the method we are checking
25 /// - `impl_m_span`: span to use for reporting errors
26 /// - `trait_m`: the method in the trait
27 /// - `impl_trait_ref`: the TraitRef corresponding to the trait implementation
29 crate fn compare_impl_method<'tcx>(
31 impl_m: &ty::AssocItem,
33 trait_m: &ty::AssocItem,
34 impl_trait_ref: ty::TraitRef<'tcx>,
35 trait_item_span: Option<Span>,
37 debug!("compare_impl_method(impl_trait_ref={:?})", impl_trait_ref);
39 let impl_m_span = tcx.sess.source_map().def_span(impl_m_span);
41 if let Err(ErrorReported) = compare_self_type(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
46 if let Err(ErrorReported) =
47 compare_number_of_generics(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
52 if let Err(ErrorReported) =
53 compare_number_of_method_arguments(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
58 if let Err(ErrorReported) = compare_synthetic_generics(tcx, impl_m, trait_m) {
62 if let Err(ErrorReported) =
63 compare_predicate_entailment(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
69 fn compare_predicate_entailment<'tcx>(
71 impl_m: &ty::AssocItem,
73 trait_m: &ty::AssocItem,
74 impl_trait_ref: ty::TraitRef<'tcx>,
75 ) -> Result<(), ErrorReported> {
76 let trait_to_impl_substs = impl_trait_ref.substs;
78 // This node-id should be used for the `body_id` field on each
79 // `ObligationCause` (and the `FnCtxt`). This is what
80 // `regionck_item` expects.
81 let impl_m_hir_id = tcx.hir().as_local_hir_id(impl_m.def_id).unwrap();
83 let cause = ObligationCause {
85 body_id: impl_m_hir_id,
86 code: ObligationCauseCode::CompareImplMethodObligation {
87 item_name: impl_m.ident.name,
88 impl_item_def_id: impl_m.def_id,
89 trait_item_def_id: trait_m.def_id,
93 // This code is best explained by example. Consider a trait:
95 // trait Trait<'t,T> {
96 // fn method<'a,M>(t: &'t T, m: &'a M) -> Self;
101 // impl<'i, 'j, U> Trait<'j, &'i U> for Foo {
102 // fn method<'b,N>(t: &'j &'i U, m: &'b N) -> Foo;
105 // We wish to decide if those two method types are compatible.
107 // We start out with trait_to_impl_substs, that maps the trait
108 // type parameters to impl type parameters. This is taken from the
109 // impl trait reference:
111 // trait_to_impl_substs = {'t => 'j, T => &'i U, Self => Foo}
113 // We create a mapping `dummy_substs` that maps from the impl type
114 // parameters to fresh types and regions. For type parameters,
115 // this is the identity transform, but we could as well use any
116 // placeholder types. For regions, we convert from bound to free
117 // regions (Note: but only early-bound regions, i.e., those
118 // declared on the impl or used in type parameter bounds).
120 // impl_to_skol_substs = {'i => 'i0, U => U0, N => N0 }
122 // Now we can apply skol_substs to the type of the impl method
123 // to yield a new function type in terms of our fresh, placeholder
126 // <'b> fn(t: &'i0 U0, m: &'b) -> Foo
128 // We now want to extract and substitute the type of the *trait*
129 // method and compare it. To do so, we must create a compound
130 // substitution by combining trait_to_impl_substs and
131 // impl_to_skol_substs, and also adding a mapping for the method
132 // type parameters. We extend the mapping to also include
133 // the method parameters.
135 // trait_to_skol_substs = { T => &'i0 U0, Self => Foo, M => N0 }
137 // Applying this to the trait method type yields:
139 // <'a> fn(t: &'i0 U0, m: &'a) -> Foo
141 // This type is also the same but the name of the bound region ('a
142 // vs 'b). However, the normal subtyping rules on fn types handle
143 // this kind of equivalency just fine.
145 // We now use these substitutions to ensure that all declared bounds are
146 // satisfied by the implementation's method.
148 // We do this by creating a parameter environment which contains a
149 // substitution corresponding to impl_to_skol_substs. We then build
150 // trait_to_skol_substs and use it to convert the predicates contained
151 // in the trait_m.generics to the placeholder form.
153 // Finally we register each of these predicates as an obligation in
154 // a fresh FulfillmentCtxt, and invoke select_all_or_error.
156 // Create mapping from impl to placeholder.
157 let impl_to_skol_substs = InternalSubsts::identity_for_item(tcx, impl_m.def_id);
159 // Create mapping from trait to placeholder.
160 let trait_to_skol_substs =
161 impl_to_skol_substs.rebase_onto(tcx, impl_m.container.id(), trait_to_impl_substs);
162 debug!("compare_impl_method: trait_to_skol_substs={:?}", trait_to_skol_substs);
164 let impl_m_generics = tcx.generics_of(impl_m.def_id);
165 let trait_m_generics = tcx.generics_of(trait_m.def_id);
166 let impl_m_predicates = tcx.predicates_of(impl_m.def_id);
167 let trait_m_predicates = tcx.predicates_of(trait_m.def_id);
169 // Check region bounds.
170 check_region_bounds_on_impl_item(
179 // Create obligations for each predicate declared by the impl
180 // definition in the context of the trait's parameter
181 // environment. We can't just use `impl_env.caller_bounds`,
182 // however, because we want to replace all late-bound regions with
184 let impl_predicates = tcx.predicates_of(impl_m_predicates.parent.unwrap());
185 let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
187 debug!("compare_impl_method: impl_bounds={:?}", hybrid_preds);
189 // This is the only tricky bit of the new way we check implementation methods
190 // We need to build a set of predicates where only the method-level bounds
191 // are from the trait and we assume all other bounds from the implementation
192 // to be previously satisfied.
194 // We then register the obligations from the impl_m and check to see
195 // if all constraints hold.
198 .extend(trait_m_predicates.instantiate_own(tcx, trait_to_skol_substs).predicates);
200 // Construct trait parameter environment and then shift it into the placeholder viewpoint.
201 // The key step here is to update the caller_bounds's predicates to be
202 // the new hybrid bounds we computed.
203 let normalize_cause = traits::ObligationCause::misc(impl_m_span, impl_m_hir_id);
204 let param_env = ty::ParamEnv::new(
205 tcx.intern_predicates(&hybrid_preds.predicates),
209 let param_env = traits::normalize_param_env_or_error(
213 normalize_cause.clone(),
216 tcx.infer_ctxt().enter(|infcx| {
217 let inh = Inherited::new(infcx, impl_m.def_id);
218 let infcx = &inh.infcx;
220 debug!("compare_impl_method: caller_bounds={:?}", param_env.caller_bounds);
222 let mut selcx = traits::SelectionContext::new(&infcx);
224 let impl_m_own_bounds = impl_m_predicates.instantiate_own(tcx, impl_to_skol_substs);
225 let (impl_m_own_bounds, _) = infcx.replace_bound_vars_with_fresh_vars(
227 infer::HigherRankedType,
228 &ty::Binder::bind(impl_m_own_bounds.predicates),
230 for predicate in impl_m_own_bounds {
231 let traits::Normalized { value: predicate, obligations } =
232 traits::normalize(&mut selcx, param_env, normalize_cause.clone(), &predicate);
234 inh.register_predicates(obligations);
235 inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
238 // We now need to check that the signature of the impl method is
239 // compatible with that of the trait method. We do this by
240 // checking that `impl_fty <: trait_fty`.
242 // FIXME. Unfortunately, this doesn't quite work right now because
243 // associated type normalization is not integrated into subtype
244 // checks. For the comparison to be valid, we need to
245 // normalize the associated types in the impl/trait methods
246 // first. However, because function types bind regions, just
247 // calling `normalize_associated_types_in` would have no effect on
248 // any associated types appearing in the fn arguments or return
251 // Compute placeholder form of impl and trait method tys.
254 let (impl_sig, _) = infcx.replace_bound_vars_with_fresh_vars(
256 infer::HigherRankedType,
257 &tcx.fn_sig(impl_m.def_id),
260 inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, &impl_sig);
261 let impl_fty = tcx.mk_fn_ptr(ty::Binder::bind(impl_sig));
262 debug!("compare_impl_method: impl_fty={:?}", impl_fty);
264 let trait_sig = tcx.liberate_late_bound_regions(impl_m.def_id, &tcx.fn_sig(trait_m.def_id));
265 let trait_sig = trait_sig.subst(tcx, trait_to_skol_substs);
267 inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, &trait_sig);
268 let trait_fty = tcx.mk_fn_ptr(ty::Binder::bind(trait_sig));
270 debug!("compare_impl_method: trait_fty={:?}", trait_fty);
272 let sub_result = infcx.at(&cause, param_env).sup(trait_fty, impl_fty).map(
273 |InferOk { obligations, .. }| {
274 inh.register_predicates(obligations);
278 if let Err(terr) = sub_result {
279 debug!("sub_types failed: impl ty {:?}, trait ty {:?}", impl_fty, trait_fty);
281 let (impl_err_span, trait_err_span) = extract_spans_for_error_reporting(
282 &infcx, param_env, &terr, &cause, impl_m, impl_sig, trait_m, trait_sig,
285 let cause = ObligationCause { span: impl_err_span, ..cause };
287 let mut diag = struct_span_err!(
291 "method `{}` has an incompatible type for trait",
294 if let TypeError::Mutability = terr {
295 if let Some(trait_err_span) = trait_err_span {
296 if let Ok(trait_err_str) = tcx.sess.source_map().span_to_snippet(trait_err_span)
298 diag.span_suggestion(
300 "consider change the type to match the mutability in trait",
302 Applicability::MachineApplicable,
311 trait_err_span.map(|sp| (sp, "type in trait".to_owned())),
312 Some(infer::ValuePairs::Types(ExpectedFound {
319 return Err(ErrorReported);
322 // Check that all obligations are satisfied by the implementation's
324 if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
325 infcx.report_fulfillment_errors(errors, None, false);
326 return Err(ErrorReported);
329 // Finally, resolve all regions. This catches wily misuses of
330 // lifetime parameters.
331 let fcx = FnCtxt::new(&inh, param_env, impl_m_hir_id);
332 fcx.regionck_item(impl_m_hir_id, impl_m_span, &[]);
338 fn check_region_bounds_on_impl_item<'tcx>(
341 impl_m: &ty::AssocItem,
342 trait_m: &ty::AssocItem,
343 trait_generics: &ty::Generics,
344 impl_generics: &ty::Generics,
345 ) -> Result<(), ErrorReported> {
346 let trait_params = trait_generics.own_counts().lifetimes;
347 let impl_params = impl_generics.own_counts().lifetimes;
350 "check_region_bounds_on_impl_item: \
351 trait_generics={:?} \
353 trait_generics, impl_generics
356 // Must have same number of early-bound lifetime parameters.
357 // Unfortunately, if the user screws up the bounds, then this
358 // will change classification between early and late. E.g.,
359 // if in trait we have `<'a,'b:'a>`, and in impl we just have
360 // `<'a,'b>`, then we have 2 early-bound lifetime parameters
361 // in trait but 0 in the impl. But if we report "expected 2
362 // but found 0" it's confusing, because it looks like there
363 // are zero. Since I don't quite know how to phrase things at
364 // the moment, give a kind of vague error message.
365 if trait_params != impl_params {
366 let item_kind = assoc_item_kind_str(impl_m);
367 let def_span = tcx.sess.source_map().def_span(span);
368 let span = tcx.hir().get_generics(impl_m.def_id).map(|g| g.span).unwrap_or(def_span);
369 let mut err = struct_span_err!(
373 "lifetime parameters or bounds on {} `{}` do not match the trait declaration",
377 err.span_label(span, &format!("lifetimes do not match {} in trait", item_kind));
378 if let Some(sp) = tcx.hir().span_if_local(trait_m.def_id) {
379 let def_sp = tcx.sess.source_map().def_span(sp);
380 let sp = tcx.hir().get_generics(trait_m.def_id).map(|g| g.span).unwrap_or(def_sp);
383 &format!("lifetimes in impl do not match this {} in trait", item_kind),
387 return Err(ErrorReported);
393 fn extract_spans_for_error_reporting<'a, 'tcx>(
394 infcx: &infer::InferCtxt<'a, 'tcx>,
395 param_env: ty::ParamEnv<'tcx>,
396 terr: &TypeError<'_>,
397 cause: &ObligationCause<'tcx>,
398 impl_m: &ty::AssocItem,
399 impl_sig: ty::FnSig<'tcx>,
400 trait_m: &ty::AssocItem,
401 trait_sig: ty::FnSig<'tcx>,
402 ) -> (Span, Option<Span>) {
404 let impl_m_hir_id = tcx.hir().as_local_hir_id(impl_m.def_id).unwrap();
405 let (impl_m_output, impl_m_iter) = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
406 ImplItemKind::Method(ref impl_m_sig, _) => {
407 (&impl_m_sig.decl.output, impl_m_sig.decl.inputs.iter())
409 _ => bug!("{:?} is not a method", impl_m),
413 TypeError::Mutability => {
414 if let Some(trait_m_hir_id) = tcx.hir().as_local_hir_id(trait_m.def_id) {
415 let trait_m_iter = match tcx.hir().expect_trait_item(trait_m_hir_id).kind {
416 TraitItemKind::Method(ref trait_m_sig, _) => trait_m_sig.decl.inputs.iter(),
417 _ => bug!("{:?} is not a TraitItemKind::Method", trait_m),
422 .find(|&(ref impl_arg, ref trait_arg)| {
423 match (&impl_arg.kind, &trait_arg.kind) {
425 &hir::TyKind::Rptr(_, ref impl_mt),
426 &hir::TyKind::Rptr(_, ref trait_mt),
428 | (&hir::TyKind::Ptr(ref impl_mt), &hir::TyKind::Ptr(ref trait_mt)) => {
429 impl_mt.mutbl != trait_mt.mutbl
434 .map(|(ref impl_arg, ref trait_arg)| (impl_arg.span, Some(trait_arg.span)))
435 .unwrap_or_else(|| (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id)))
437 (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id))
440 TypeError::Sorts(ExpectedFound { .. }) => {
441 if let Some(trait_m_hir_id) = tcx.hir().as_local_hir_id(trait_m.def_id) {
442 let (trait_m_output, trait_m_iter) =
443 match tcx.hir().expect_trait_item(trait_m_hir_id).kind {
444 TraitItemKind::Method(ref trait_m_sig, _) => {
445 (&trait_m_sig.decl.output, trait_m_sig.decl.inputs.iter())
447 _ => bug!("{:?} is not a TraitItemKind::Method", trait_m),
450 let impl_iter = impl_sig.inputs().iter();
451 let trait_iter = trait_sig.inputs().iter();
457 |(((&impl_arg_ty, &trait_arg_ty), impl_arg), trait_arg)| match infcx
458 .at(&cause, param_env)
459 .sub(trait_arg_ty, impl_arg_ty)
462 Err(_) => Some((impl_arg.span, Some(trait_arg.span))),
468 .at(&cause, param_env)
469 .sup(trait_sig.output(), impl_sig.output())
472 (impl_m_output.span(), Some(trait_m_output.span()))
474 (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id))
478 (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id))
481 _ => (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id)),
485 fn compare_self_type<'tcx>(
487 impl_m: &ty::AssocItem,
489 trait_m: &ty::AssocItem,
490 impl_trait_ref: ty::TraitRef<'tcx>,
491 ) -> Result<(), ErrorReported> {
492 // Try to give more informative error messages about self typing
493 // mismatches. Note that any mismatch will also be detected
494 // below, where we construct a canonical function type that
495 // includes the self parameter as a normal parameter. It's just
496 // that the error messages you get out of this code are a bit more
497 // inscrutable, particularly for cases where one method has no
500 let self_string = |method: &ty::AssocItem| {
501 let untransformed_self_ty = match method.container {
502 ty::ImplContainer(_) => impl_trait_ref.self_ty(),
503 ty::TraitContainer(_) => tcx.types.self_param,
505 let self_arg_ty = *tcx.fn_sig(method.def_id).input(0).skip_binder();
506 let param_env = ty::ParamEnv::reveal_all();
508 tcx.infer_ctxt().enter(|infcx| {
510 tcx.liberate_late_bound_regions(method.def_id, &ty::Binder::bind(self_arg_ty));
511 let can_eq_self = |ty| infcx.can_eq(param_env, untransformed_self_ty, ty).is_ok();
512 match ExplicitSelf::determine(self_arg_ty, can_eq_self) {
513 ExplicitSelf::ByValue => "self".to_owned(),
514 ExplicitSelf::ByReference(_, hir::Mutability::Not) => "&self".to_owned(),
515 ExplicitSelf::ByReference(_, hir::Mutability::Mut) => "&mut self".to_owned(),
516 _ => format!("self: {}", self_arg_ty),
521 match (trait_m.method_has_self_argument, impl_m.method_has_self_argument) {
522 (false, false) | (true, true) => {}
525 let self_descr = self_string(impl_m);
526 let mut err = struct_span_err!(
530 "method `{}` has a `{}` declaration in the impl, but \
535 err.span_label(impl_m_span, format!("`{}` used in impl", self_descr));
536 if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
537 err.span_label(span, format!("trait method declared without `{}`", self_descr));
539 err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
542 return Err(ErrorReported);
546 let self_descr = self_string(trait_m);
547 let mut err = struct_span_err!(
551 "method `{}` has a `{}` declaration in the trait, but \
556 err.span_label(impl_m_span, format!("expected `{}` in impl", self_descr));
557 if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
558 err.span_label(span, format!("`{}` used in trait", self_descr));
560 err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
563 return Err(ErrorReported);
570 fn compare_number_of_generics<'tcx>(
572 impl_: &ty::AssocItem,
574 trait_: &ty::AssocItem,
575 trait_span: Option<Span>,
576 ) -> Result<(), ErrorReported> {
577 let trait_own_counts = tcx.generics_of(trait_.def_id).own_counts();
578 let impl_own_counts = tcx.generics_of(impl_.def_id).own_counts();
581 ("type", trait_own_counts.types, impl_own_counts.types),
582 ("const", trait_own_counts.consts, impl_own_counts.consts),
585 let item_kind = assoc_item_kind_str(impl_);
587 let mut err_occurred = false;
588 for &(kind, trait_count, impl_count) in &matchings {
589 if impl_count != trait_count {
592 let (trait_spans, impl_trait_spans) =
593 if let Some(trait_hir_id) = tcx.hir().as_local_hir_id(trait_.def_id) {
594 let trait_item = tcx.hir().expect_trait_item(trait_hir_id);
595 if trait_item.generics.params.is_empty() {
596 (Some(vec![trait_item.generics.span]), vec![])
598 let arg_spans: Vec<Span> =
599 trait_item.generics.params.iter().map(|p| p.span).collect();
600 let impl_trait_spans: Vec<Span> = trait_item
604 .filter_map(|p| match p.kind {
605 GenericParamKind::Type {
606 synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
612 (Some(arg_spans), impl_trait_spans)
615 (trait_span.map(|s| vec![s]), vec![])
618 let impl_hir_id = tcx.hir().as_local_hir_id(impl_.def_id).unwrap();
619 let impl_item = tcx.hir().expect_impl_item(impl_hir_id);
620 let impl_item_impl_trait_spans: Vec<Span> = impl_item
624 .filter_map(|p| match p.kind {
625 GenericParamKind::Type {
626 synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
632 let spans = impl_item.generics.spans();
633 let span = spans.primary_span();
635 let mut err = tcx.sess.struct_span_err_with_code(
638 "{} `{}` has {} {kind} parameter{} but its trait \
639 declaration has {} {kind} parameter{}",
643 pluralize!(impl_count),
645 pluralize!(trait_count),
648 DiagnosticId::Error("E0049".into()),
651 let mut suffix = None;
653 if let Some(spans) = trait_spans {
654 let mut spans = spans.iter();
655 if let Some(span) = spans.next() {
659 "expected {} {} parameter{}",
662 pluralize!(trait_count),
667 err.span_label(*span, "");
670 suffix = Some(format!(", expected {}", trait_count));
673 if let Some(span) = span {
677 "found {} {} parameter{}{}",
680 pluralize!(impl_count),
681 suffix.unwrap_or_else(|| String::new()),
686 for span in impl_trait_spans.iter().chain(impl_item_impl_trait_spans.iter()) {
687 err.span_label(*span, "`impl Trait` introduces an implicit type parameter");
694 if err_occurred { Err(ErrorReported) } else { Ok(()) }
697 fn compare_number_of_method_arguments<'tcx>(
699 impl_m: &ty::AssocItem,
701 trait_m: &ty::AssocItem,
702 trait_item_span: Option<Span>,
703 ) -> Result<(), ErrorReported> {
704 let impl_m_fty = tcx.fn_sig(impl_m.def_id);
705 let trait_m_fty = tcx.fn_sig(trait_m.def_id);
706 let trait_number_args = trait_m_fty.inputs().skip_binder().len();
707 let impl_number_args = impl_m_fty.inputs().skip_binder().len();
708 if trait_number_args != impl_number_args {
709 let trait_m_hir_id = tcx.hir().as_local_hir_id(trait_m.def_id);
710 let trait_span = if let Some(trait_id) = trait_m_hir_id {
711 match tcx.hir().expect_trait_item(trait_id).kind {
712 TraitItemKind::Method(ref trait_m_sig, _) => {
713 let pos = if trait_number_args > 0 { trait_number_args - 1 } else { 0 };
714 if let Some(arg) = trait_m_sig.decl.inputs.get(pos) {
719 trait_m_sig.decl.inputs[0].span.lo(),
728 _ => bug!("{:?} is not a method", impl_m),
733 let impl_m_hir_id = tcx.hir().as_local_hir_id(impl_m.def_id).unwrap();
734 let impl_span = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
735 ImplItemKind::Method(ref impl_m_sig, _) => {
736 let pos = if impl_number_args > 0 { impl_number_args - 1 } else { 0 };
737 if let Some(arg) = impl_m_sig.decl.inputs.get(pos) {
742 impl_m_sig.decl.inputs[0].span.lo(),
751 _ => bug!("{:?} is not a method", impl_m),
753 let mut err = struct_span_err!(
757 "method `{}` has {} but the declaration in \
760 potentially_plural_count(impl_number_args, "parameter"),
761 tcx.def_path_str(trait_m.def_id),
764 if let Some(trait_span) = trait_span {
769 potentially_plural_count(trait_number_args, "parameter")
773 err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
778 "expected {}, found {}",
779 potentially_plural_count(trait_number_args, "parameter"),
784 return Err(ErrorReported);
790 fn compare_synthetic_generics<'tcx>(
792 impl_m: &ty::AssocItem,
793 trait_m: &ty::AssocItem,
794 ) -> Result<(), ErrorReported> {
795 // FIXME(chrisvittal) Clean up this function, list of FIXME items:
796 // 1. Better messages for the span labels
797 // 2. Explanation as to what is going on
798 // If we get here, we already have the same number of generics, so the zip will
800 let mut error_found = false;
801 let impl_m_generics = tcx.generics_of(impl_m.def_id);
802 let trait_m_generics = tcx.generics_of(trait_m.def_id);
803 let impl_m_type_params = impl_m_generics.params.iter().filter_map(|param| match param.kind {
804 GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
805 GenericParamDefKind::Lifetime | GenericParamDefKind::Const => None,
807 let trait_m_type_params = trait_m_generics.params.iter().filter_map(|param| match param.kind {
808 GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
809 GenericParamDefKind::Lifetime | GenericParamDefKind::Const => None,
811 for ((impl_def_id, impl_synthetic), (trait_def_id, trait_synthetic)) in
812 impl_m_type_params.zip(trait_m_type_params)
814 if impl_synthetic != trait_synthetic {
815 let impl_hir_id = tcx.hir().as_local_hir_id(impl_def_id).unwrap();
816 let impl_span = tcx.hir().span(impl_hir_id);
817 let trait_span = tcx.def_span(trait_def_id);
818 let mut err = struct_span_err!(
822 "method `{}` has incompatible signature for trait",
825 err.span_label(trait_span, "declaration in trait here");
826 match (impl_synthetic, trait_synthetic) {
827 // The case where the impl method uses `impl Trait` but the trait method uses
829 (Some(hir::SyntheticTyParamKind::ImplTrait), None) => {
830 err.span_label(impl_span, "expected generic parameter, found `impl Trait`");
832 // try taking the name from the trait impl
833 // FIXME: this is obviously suboptimal since the name can already be used
834 // as another generic argument
835 let new_name = tcx.sess.source_map().span_to_snippet(trait_span).ok()?;
836 let trait_m = tcx.hir().as_local_hir_id(trait_m.def_id)?;
837 let trait_m = tcx.hir().trait_item(hir::TraitItemId { hir_id: trait_m });
839 let impl_m = tcx.hir().as_local_hir_id(impl_m.def_id)?;
840 let impl_m = tcx.hir().impl_item(hir::ImplItemId { hir_id: impl_m });
842 // in case there are no generics, take the spot between the function name
843 // and the opening paren of the argument list
844 let new_generics_span =
845 tcx.sess.source_map().generate_fn_name_span(impl_span)?.shrink_to_hi();
846 // in case there are generics, just replace them
848 impl_m.generics.span.substitute_dummy(new_generics_span);
849 // replace with the generics from the trait
851 tcx.sess.source_map().span_to_snippet(trait_m.generics.span).ok()?;
853 err.multipart_suggestion(
854 "try changing the `impl Trait` argument to a generic parameter",
856 // replace `impl Trait` with `T`
857 (impl_span, new_name),
858 // replace impl method generics with trait method generics
859 // This isn't quite right, as users might have changed the names
860 // of the generics, but it works for the common case
861 (generics_span, new_generics),
863 Applicability::MaybeIncorrect,
868 // The case where the trait method uses `impl Trait`, but the impl method uses
869 // explicit generics.
870 (None, Some(hir::SyntheticTyParamKind::ImplTrait)) => {
871 err.span_label(impl_span, "expected `impl Trait`, found generic parameter");
873 let impl_m = tcx.hir().as_local_hir_id(impl_m.def_id)?;
874 let impl_m = tcx.hir().impl_item(hir::ImplItemId { hir_id: impl_m });
875 let input_tys = match impl_m.kind {
876 hir::ImplItemKind::Method(ref sig, _) => sig.decl.inputs,
879 struct Visitor(Option<Span>, hir::def_id::DefId);
880 impl<'v> intravisit::Visitor<'v> for Visitor {
881 fn visit_ty(&mut self, ty: &'v hir::Ty<'v>) {
882 intravisit::walk_ty(self, ty);
883 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) =
886 if let Res::Def(DefKind::TyParam, def_id) = path.res {
887 if def_id == self.1 {
888 self.0 = Some(ty.span);
893 fn nested_visit_map<'this>(
895 ) -> intravisit::NestedVisitorMap<'this, 'v>
897 intravisit::NestedVisitorMap::None
900 let mut visitor = Visitor(None, impl_def_id);
901 for ty in input_tys {
902 intravisit::Visitor::visit_ty(&mut visitor, ty);
904 let span = visitor.0?;
907 impl_m.generics.params.iter().find_map(|param| match param.kind {
908 GenericParamKind::Lifetime { .. } => None,
909 GenericParamKind::Type { .. } | GenericParamKind::Const { .. } => {
910 if param.hir_id == impl_hir_id {
917 let bounds = bounds.first()?.span().to(bounds.last()?.span());
918 let bounds = tcx.sess.source_map().span_to_snippet(bounds).ok()?;
920 err.multipart_suggestion(
921 "try removing the generic parameter and using `impl Trait` instead",
923 // delete generic parameters
924 (impl_m.generics.span, String::new()),
925 // replace param usage with `impl Trait`
926 (span, format!("impl {}", bounds)),
928 Applicability::MaybeIncorrect,
939 if error_found { Err(ErrorReported) } else { Ok(()) }
942 crate fn compare_const_impl<'tcx>(
944 impl_c: &ty::AssocItem,
946 trait_c: &ty::AssocItem,
947 impl_trait_ref: ty::TraitRef<'tcx>,
949 debug!("compare_const_impl(impl_trait_ref={:?})", impl_trait_ref);
951 tcx.infer_ctxt().enter(|infcx| {
952 let param_env = tcx.param_env(impl_c.def_id);
953 let inh = Inherited::new(infcx, impl_c.def_id);
954 let infcx = &inh.infcx;
956 // The below is for the most part highly similar to the procedure
957 // for methods above. It is simpler in many respects, especially
958 // because we shouldn't really have to deal with lifetimes or
959 // predicates. In fact some of this should probably be put into
960 // shared functions because of DRY violations...
961 let trait_to_impl_substs = impl_trait_ref.substs;
963 // Create a parameter environment that represents the implementation's
965 let impl_c_hir_id = tcx.hir().as_local_hir_id(impl_c.def_id).unwrap();
967 // Compute placeholder form of impl and trait const tys.
968 let impl_ty = tcx.type_of(impl_c.def_id);
969 let trait_ty = tcx.type_of(trait_c.def_id).subst(tcx, trait_to_impl_substs);
970 let mut cause = ObligationCause::misc(impl_c_span, impl_c_hir_id);
972 // There is no "body" here, so just pass dummy id.
974 inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, &impl_ty);
976 debug!("compare_const_impl: impl_ty={:?}", impl_ty);
979 inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, &trait_ty);
981 debug!("compare_const_impl: trait_ty={:?}", trait_ty);
984 .at(&cause, param_env)
985 .sup(trait_ty, impl_ty)
986 .map(|ok| inh.register_infer_ok_obligations(ok));
988 if let Err(terr) = err {
990 "checking associated const for compatibility: impl ty {:?}, trait ty {:?}",
994 // Locate the Span containing just the type of the offending impl
995 match tcx.hir().expect_impl_item(impl_c_hir_id).kind {
996 ImplItemKind::Const(ref ty, _) => cause.span = ty.span,
997 _ => bug!("{:?} is not a impl const", impl_c),
1000 let mut diag = struct_span_err!(
1004 "implemented const `{}` has an incompatible type for \
1009 let trait_c_hir_id = tcx.hir().as_local_hir_id(trait_c.def_id);
1010 let trait_c_span = trait_c_hir_id.map(|trait_c_hir_id| {
1011 // Add a label to the Span containing just the type of the const
1012 match tcx.hir().expect_trait_item(trait_c_hir_id).kind {
1013 TraitItemKind::Const(ref ty, _) => ty.span,
1014 _ => bug!("{:?} is not a trait const", trait_c),
1018 infcx.note_type_err(
1021 trait_c_span.map(|span| (span, "type in trait".to_owned())),
1022 Some(infer::ValuePairs::Types(ExpectedFound {
1031 // Check that all obligations are satisfied by the implementation's
1033 if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
1034 infcx.report_fulfillment_errors(errors, None, false);
1038 let fcx = FnCtxt::new(&inh, param_env, impl_c_hir_id);
1039 fcx.regionck_item(impl_c_hir_id, impl_c_span, &[]);
1043 crate fn compare_ty_impl<'tcx>(
1045 impl_ty: &ty::AssocItem,
1047 trait_ty: &ty::AssocItem,
1048 impl_trait_ref: ty::TraitRef<'tcx>,
1049 trait_item_span: Option<Span>,
1051 debug!("compare_impl_type(impl_trait_ref={:?})", impl_trait_ref);
1053 let _: Result<(), ErrorReported> = (|| {
1054 compare_number_of_generics(tcx, impl_ty, impl_ty_span, trait_ty, trait_item_span)?;
1056 compare_type_predicate_entailment(tcx, impl_ty, impl_ty_span, trait_ty, impl_trait_ref)
1060 /// The equivalent of [compare_predicate_entailment], but for associated types
1061 /// instead of associated functions.
1062 fn compare_type_predicate_entailment(
1064 impl_ty: &ty::AssocItem,
1066 trait_ty: &ty::AssocItem,
1067 impl_trait_ref: ty::TraitRef<'tcx>,
1068 ) -> Result<(), ErrorReported> {
1069 let impl_substs = InternalSubsts::identity_for_item(tcx, impl_ty.def_id);
1070 let trait_to_impl_substs =
1071 impl_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1073 let impl_ty_generics = tcx.generics_of(impl_ty.def_id);
1074 let trait_ty_generics = tcx.generics_of(trait_ty.def_id);
1075 let impl_ty_predicates = tcx.predicates_of(impl_ty.def_id);
1076 let trait_ty_predicates = tcx.predicates_of(trait_ty.def_id);
1078 check_region_bounds_on_impl_item(
1087 let impl_ty_own_bounds = impl_ty_predicates.instantiate_own(tcx, impl_substs);
1089 if impl_ty_own_bounds.is_empty() {
1090 // Nothing to check.
1094 // This `HirId` should be used for the `body_id` field on each
1095 // `ObligationCause` (and the `FnCtxt`). This is what
1096 // `regionck_item` expects.
1097 let impl_ty_hir_id = tcx.hir().as_local_hir_id(impl_ty.def_id).unwrap();
1098 let cause = ObligationCause {
1100 body_id: impl_ty_hir_id,
1101 code: ObligationCauseCode::CompareImplTypeObligation {
1102 item_name: impl_ty.ident.name,
1103 impl_item_def_id: impl_ty.def_id,
1104 trait_item_def_id: trait_ty.def_id,
1108 debug!("compare_type_predicate_entailment: trait_to_impl_substs={:?}", trait_to_impl_substs);
1110 // The predicates declared by the impl definition, the trait and the
1111 // associated type in the trait are assumed.
1112 let impl_predicates = tcx.predicates_of(impl_ty_predicates.parent.unwrap());
1113 let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
1116 .extend(trait_ty_predicates.instantiate_own(tcx, trait_to_impl_substs).predicates);
1118 debug!("compare_type_predicate_entailment: bounds={:?}", hybrid_preds);
1120 let normalize_cause = traits::ObligationCause::misc(impl_ty_span, impl_ty_hir_id);
1121 let param_env = ty::ParamEnv::new(
1122 tcx.intern_predicates(&hybrid_preds.predicates),
1126 let param_env = traits::normalize_param_env_or_error(
1130 normalize_cause.clone(),
1132 tcx.infer_ctxt().enter(|infcx| {
1133 let inh = Inherited::new(infcx, impl_ty.def_id);
1134 let infcx = &inh.infcx;
1136 debug!("compare_type_predicate_entailment: caller_bounds={:?}", param_env.caller_bounds);
1138 let mut selcx = traits::SelectionContext::new(&infcx);
1140 for predicate in impl_ty_own_bounds.predicates {
1141 let traits::Normalized { value: predicate, obligations } =
1142 traits::normalize(&mut selcx, param_env, normalize_cause.clone(), &predicate);
1144 inh.register_predicates(obligations);
1145 inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
1148 // Check that all obligations are satisfied by the implementation's
1150 if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
1151 infcx.report_fulfillment_errors(errors, None, false);
1152 return Err(ErrorReported);
1155 // Finally, resolve all regions. This catches wily misuses of
1156 // lifetime parameters.
1157 let fcx = FnCtxt::new(&inh, param_env, impl_ty_hir_id);
1158 fcx.regionck_item(impl_ty_hir_id, impl_ty_span, &[]);
1164 fn assoc_item_kind_str(impl_item: &ty::AssocItem) -> &'static str {
1165 match impl_item.kind {
1166 ty::AssocKind::Const => "const",
1167 ty::AssocKind::Method => "method",
1168 ty::AssocKind::Type | ty::AssocKind::OpaqueTy => "type",