2 use super::CandidateSource;
3 use super::MethodError;
4 use super::NoMatchData;
6 use crate::errors::MethodCallOnUnknownType;
8 use rustc_data_structures::fx::FxHashSet;
9 use rustc_errors::Applicability;
11 use rustc_hir::def::DefKind;
12 use rustc_hir_analysis::autoderef::{self, Autoderef};
13 use rustc_infer::infer::canonical::OriginalQueryValues;
14 use rustc_infer::infer::canonical::{Canonical, QueryResponse};
15 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
16 use rustc_infer::infer::{self, InferOk, TyCtxtInferExt};
17 use rustc_middle::infer::unify_key::{ConstVariableOrigin, ConstVariableOriginKind};
18 use rustc_middle::middle::stability;
19 use rustc_middle::ty::fast_reject::{simplify_type, TreatParams};
20 use rustc_middle::ty::AssocItem;
21 use rustc_middle::ty::GenericParamDefKind;
22 use rustc_middle::ty::ToPredicate;
23 use rustc_middle::ty::{self, ParamEnvAnd, Ty, TyCtxt, TypeFoldable, TypeVisitable};
24 use rustc_middle::ty::{InternalSubsts, SubstsRef};
25 use rustc_session::lint;
26 use rustc_span::def_id::DefId;
27 use rustc_span::def_id::LocalDefId;
28 use rustc_span::lev_distance::{
29 find_best_match_for_name_with_substrings, lev_distance_with_substrings,
31 use rustc_span::symbol::sym;
32 use rustc_span::{symbol::Ident, Span, Symbol, DUMMY_SP};
33 use rustc_trait_selection::traits::query::evaluate_obligation::InferCtxtExt;
34 use rustc_trait_selection::traits::query::method_autoderef::MethodAutoderefBadTy;
35 use rustc_trait_selection::traits::query::method_autoderef::{
36 CandidateStep, MethodAutoderefStepsResult,
38 use rustc_trait_selection::traits::query::CanonicalTyGoal;
39 use rustc_trait_selection::traits::NormalizeExt;
40 use rustc_trait_selection::traits::{self, ObligationCause};
41 use std::cell::RefCell;
46 use smallvec::{smallvec, SmallVec};
48 use self::CandidateKind::*;
49 pub use self::PickKind::*;
51 /// Boolean flag used to indicate if this search is for a suggestion
52 /// or not. If true, we can allow ambiguity and so forth.
53 #[derive(Clone, Copy, Debug)]
54 pub struct IsSuggestion(pub bool);
56 struct ProbeContext<'a, 'tcx> {
57 fcx: &'a FnCtxt<'a, 'tcx>,
60 method_name: Option<Ident>,
61 return_type: Option<Ty<'tcx>>,
63 /// This is the OriginalQueryValues for the steps queries
64 /// that are answered in steps.
65 orig_steps_var_values: &'a OriginalQueryValues<'tcx>,
66 steps: &'tcx [CandidateStep<'tcx>],
68 inherent_candidates: Vec<Candidate<'tcx>>,
69 extension_candidates: Vec<Candidate<'tcx>>,
70 impl_dups: FxHashSet<DefId>,
72 /// When probing for names, include names that are close to the
73 /// requested name (by Levenshtein distance)
74 allow_similar_names: bool,
76 /// Some(candidate) if there is a private candidate
77 private_candidate: Option<(DefKind, DefId)>,
79 /// Collects near misses when the candidate functions are missing a `self` keyword and is only
80 /// used for error reporting
81 static_candidates: RefCell<Vec<CandidateSource>>,
83 /// Collects near misses when trait bounds for type parameters are unsatisfied and is only used
84 /// for error reporting
85 unsatisfied_predicates: RefCell<
86 Vec<(ty::Predicate<'tcx>, Option<ty::Predicate<'tcx>>, Option<ObligationCause<'tcx>>)>,
89 scope_expr_id: hir::HirId,
92 impl<'a, 'tcx> Deref for ProbeContext<'a, 'tcx> {
93 type Target = FnCtxt<'a, 'tcx>;
94 fn deref(&self) -> &Self::Target {
99 #[derive(Debug, Clone)]
100 pub(crate) struct Candidate<'tcx> {
101 // Candidates are (I'm not quite sure, but they are mostly) basically
102 // some metadata on top of a `ty::AssocItem` (without substs).
104 // However, method probing wants to be able to evaluate the predicates
105 // for a function with the substs applied - for example, if a function
106 // has `where Self: Sized`, we don't want to consider it unless `Self`
107 // is actually `Sized`, and similarly, return-type suggestions want
108 // to consider the "actual" return type.
110 // The way this is handled is through `xform_self_ty`. It contains
111 // the receiver type of this candidate, but `xform_self_ty`,
112 // `xform_ret_ty` and `kind` (which contains the predicates) have the
113 // generic parameters of this candidate substituted with the *same set*
114 // of inference variables, which acts as some weird sort of "query".
116 // When we check out a candidate, we require `xform_self_ty` to be
117 // a subtype of the passed-in self-type, and this equates the type
118 // variables in the rest of the fields.
120 // For example, if we have this candidate:
123 // fn foo(&self) where Self: Sized;
127 // Then `xform_self_ty` will be `&'erased ?X` and `kind` will contain
128 // the predicate `?X: Sized`, so if we are evaluating `Foo` for a
129 // the receiver `&T`, we'll do the subtyping which will make `?X`
130 // get the right value, then when we evaluate the predicate we'll check
132 xform_self_ty: Ty<'tcx>,
133 xform_ret_ty: Option<Ty<'tcx>>,
134 pub(crate) item: ty::AssocItem,
135 pub(crate) kind: CandidateKind<'tcx>,
136 pub(crate) import_ids: SmallVec<[LocalDefId; 1]>,
139 #[derive(Debug, Clone)]
140 pub(crate) enum CandidateKind<'tcx> {
141 InherentImplCandidate(
143 // Normalize obligations
144 Vec<traits::PredicateObligation<'tcx>>,
147 TraitCandidate(ty::TraitRef<'tcx>),
148 WhereClauseCandidate(
150 ty::PolyTraitRef<'tcx>,
154 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
161 /// When adjusting a receiver we often want to do one of
163 /// - Add a `&` (or `&mut`), converting the receiver from `T` to `&T` (or `&mut T`)
164 /// - If the receiver has type `*mut T`, convert it to `*const T`
166 /// This type tells us which one to do.
168 /// Note that in principle we could do both at the same time. For example, when the receiver has
169 /// type `T`, we could autoref it to `&T`, then convert to `*const T`. Or, when it has type `*mut
170 /// T`, we could convert it to `*const T`, then autoref to `&*const T`. However, currently we do
171 /// (at most) one of these. Either the receiver has type `T` and we convert it to `&T` (or with
172 /// `mut`), or it has type `*mut T` and we convert it to `*const T`.
173 #[derive(Debug, PartialEq, Copy, Clone)]
174 pub enum AutorefOrPtrAdjustment {
175 /// Receiver has type `T`, add `&` or `&mut` (it `T` is `mut`), and maybe also "unsize" it.
176 /// Unsizing is used to convert a `[T; N]` to `[T]`, which only makes sense when autorefing.
178 mutbl: hir::Mutability,
180 /// Indicates that the source expression should be "unsized" to a target type.
181 /// This is special-cased for just arrays unsizing to slices.
184 /// Receiver has type `*mut T`, convert to `*const T`
188 impl AutorefOrPtrAdjustment {
189 fn get_unsize(&self) -> bool {
191 AutorefOrPtrAdjustment::Autoref { mutbl: _, unsize } => *unsize,
192 AutorefOrPtrAdjustment::ToConstPtr => false,
197 #[derive(Debug, Clone)]
198 pub struct Pick<'tcx> {
199 pub item: ty::AssocItem,
200 pub kind: PickKind<'tcx>,
201 pub import_ids: SmallVec<[LocalDefId; 1]>,
203 /// Indicates that the source expression should be autoderef'd N times
204 /// ```ignore (not-rust)
205 /// A = expr | *expr | **expr | ...
207 pub autoderefs: usize,
209 /// Indicates that we want to add an autoref (and maybe also unsize it), or if the receiver is
210 /// `*mut T`, convert it to `*const T`.
211 pub autoref_or_ptr_adjustment: Option<AutorefOrPtrAdjustment>,
212 pub self_ty: Ty<'tcx>,
214 /// Unstable candidates alongside the stable ones.
215 unstable_candidates: Vec<(Candidate<'tcx>, Symbol)>,
218 #[derive(Clone, Debug, PartialEq, Eq)]
219 pub enum PickKind<'tcx> {
225 ty::PolyTraitRef<'tcx>,
229 pub type PickResult<'tcx> = Result<Pick<'tcx>, MethodError<'tcx>>;
231 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
233 // An expression of the form `receiver.method_name(...)`.
234 // Autoderefs are performed on `receiver`, lookup is done based on the
235 // `self` argument of the method, and static methods aren't considered.
237 // An expression of the form `Type::item` or `<T>::item`.
238 // No autoderefs are performed, lookup is done based on the type each
239 // implementation is for, and static methods are included.
243 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
244 pub enum ProbeScope {
245 // Assemble candidates coming only from traits in scope.
248 // Assemble candidates coming from all traits.
252 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
253 /// This is used to offer suggestions to users. It returns methods
254 /// that could have been called which have the desired return
255 /// type. Some effort is made to rule out methods that, if called,
256 /// would result in an error (basically, the same criteria we
257 /// would use to decide if a method is a plausible fit for
258 /// ambiguity purposes).
259 #[instrument(level = "debug", skip(self, candidate_filter))]
260 pub fn probe_for_return_type(
264 return_type: Ty<'tcx>,
266 scope_expr_id: hir::HirId,
267 candidate_filter: impl Fn(&ty::AssocItem) -> bool,
268 ) -> Vec<ty::AssocItem> {
269 let method_names = self
278 ProbeScope::AllTraits,
279 |probe_cx| Ok(probe_cx.candidate_method_names(candidate_filter)),
281 .unwrap_or_default();
284 .flat_map(|&method_name| {
293 ProbeScope::AllTraits,
294 |probe_cx| probe_cx.pick(),
297 .map(|pick| pick.item)
302 #[instrument(level = "debug", skip(self))]
303 pub fn probe_for_name(
307 return_type: Option<Ty<'tcx>>,
308 is_suggestion: IsSuggestion,
310 scope_expr_id: hir::HirId,
312 ) -> PickResult<'tcx> {
322 |probe_cx| probe_cx.pick(),
326 #[instrument(level = "debug", skip(self))]
327 pub(crate) fn probe_for_name_many(
331 return_type: Option<Ty<'tcx>>,
332 is_suggestion: IsSuggestion,
334 scope_expr_id: hir::HirId,
336 ) -> Vec<Candidate<'tcx>> {
350 .chain(probe_cx.extension_candidates)
361 method_name: Option<Ident>,
362 return_type: Option<Ty<'tcx>>,
363 is_suggestion: IsSuggestion,
365 scope_expr_id: hir::HirId,
368 ) -> Result<R, MethodError<'tcx>>
370 OP: FnOnce(ProbeContext<'_, 'tcx>) -> Result<R, MethodError<'tcx>>,
372 let mut orig_values = OriginalQueryValues::default();
373 let param_env_and_self_ty = self.canonicalize_query(
374 ParamEnvAnd { param_env: self.param_env, value: self_ty },
378 let steps = match mode {
379 Mode::MethodCall => self.tcx.method_autoderef_steps(param_env_and_self_ty),
380 Mode::Path => self.probe(|_| {
381 // Mode::Path - the deref steps is "trivial". This turns
382 // our CanonicalQuery into a "trivial" QueryResponse. This
383 // is a bit inefficient, but I don't think that writing
384 // special handling for this "trivial case" is a good idea.
386 let infcx = &self.infcx;
387 let (ParamEnvAnd { param_env: _, value: self_ty }, canonical_inference_vars) =
388 infcx.instantiate_canonical_with_fresh_inference_vars(
390 ¶m_env_and_self_ty,
393 "probe_op: Mode::Path, param_env_and_self_ty={:?} self_ty={:?}",
394 param_env_and_self_ty, self_ty
396 MethodAutoderefStepsResult {
397 steps: infcx.tcx.arena.alloc_from_iter([CandidateStep {
398 self_ty: self.make_query_response_ignoring_pending_obligations(
399 canonical_inference_vars,
403 from_unsafe_deref: false,
407 reached_recursion_limit: false,
412 // If our autoderef loop had reached the recursion limit,
413 // report an overflow error, but continue going on with
414 // the truncated autoderef list.
415 if steps.reached_recursion_limit {
420 .unwrap_or_else(|| span_bug!(span, "reached the recursion limit in 0 steps?"))
423 .probe_instantiate_query_response(span, &orig_values, ty)
424 .unwrap_or_else(|_| span_bug!(span, "instantiating {:?} failed?", ty));
425 autoderef::report_autoderef_recursion_limit_error(self.tcx, span, ty.value);
429 // If we encountered an `_` type or an error type during autoderef, this is
431 if let Some(bad_ty) = &steps.opt_bad_ty {
433 // Ambiguity was encountered during a suggestion. Just keep going.
434 debug!("ProbeContext: encountered ambiguity in suggestion");
435 } else if bad_ty.reached_raw_pointer && !self.tcx.features().arbitrary_self_types {
436 // this case used to be allowed by the compiler,
437 // so we do a future-compat lint here for the 2015 edition
438 // (see https://github.com/rust-lang/rust/issues/46906)
439 if self.tcx.sess.rust_2018() {
440 self.tcx.sess.emit_err(MethodCallOnUnknownType { span });
442 self.tcx.struct_span_lint_hir(
443 lint::builtin::TYVAR_BEHIND_RAW_POINTER,
446 "type annotations needed",
451 // Encountered a real ambiguity, so abort the lookup. If `ty` is not
452 // an `Err`, report the right "type annotations needed" error pointing
456 .probe_instantiate_query_response(span, &orig_values, ty)
457 .unwrap_or_else(|_| span_bug!(span, "instantiating {:?} failed?", ty));
458 let ty = self.structurally_resolved_type(span, ty.value);
459 assert!(matches!(ty.kind(), ty::Error(_)));
460 return Err(MethodError::NoMatch(NoMatchData {
461 static_candidates: Vec::new(),
462 unsatisfied_predicates: Vec::new(),
463 out_of_scope_traits: Vec::new(),
464 similar_candidate: None,
470 debug!("ProbeContext: steps for self_ty={:?} are {:?}", self_ty, steps);
472 // this creates one big transaction so that all type variables etc
473 // that we create during the probe process are removed later
475 let mut probe_cx = ProbeContext::new(
486 probe_cx.assemble_inherent_candidates();
488 ProbeScope::TraitsInScope => {
489 probe_cx.assemble_extension_candidates_for_traits_in_scope()
491 ProbeScope::AllTraits => probe_cx.assemble_extension_candidates_for_all_traits(),
498 pub fn provide(providers: &mut ty::query::Providers) {
499 providers.method_autoderef_steps = method_autoderef_steps;
502 fn method_autoderef_steps<'tcx>(
504 goal: CanonicalTyGoal<'tcx>,
505 ) -> MethodAutoderefStepsResult<'tcx> {
506 debug!("method_autoderef_steps({:?})", goal);
508 let (ref infcx, goal, inference_vars) = tcx.infer_ctxt().build_with_canonical(DUMMY_SP, &goal);
509 let ParamEnvAnd { param_env, value: self_ty } = goal;
512 Autoderef::new(infcx, param_env, hir::def_id::CRATE_DEF_ID, DUMMY_SP, self_ty)
513 .include_raw_pointers()
515 let mut reached_raw_pointer = false;
516 let mut steps: Vec<_> = autoderef
519 let step = CandidateStep {
521 .make_query_response_ignoring_pending_obligations(inference_vars.clone(), ty),
523 from_unsafe_deref: reached_raw_pointer,
526 if let ty::RawPtr(_) = ty.kind() {
527 // all the subsequent steps will be from_unsafe_deref
528 reached_raw_pointer = true;
534 let final_ty = autoderef.final_ty(true);
535 let opt_bad_ty = match final_ty.kind() {
536 ty::Infer(ty::TyVar(_)) | ty::Error(_) => Some(MethodAutoderefBadTy {
538 ty: infcx.make_query_response_ignoring_pending_obligations(inference_vars, final_ty),
540 ty::Array(elem_ty, _) => {
541 let dereferences = steps.len() - 1;
543 steps.push(CandidateStep {
544 self_ty: infcx.make_query_response_ignoring_pending_obligations(
546 infcx.tcx.mk_slice(*elem_ty),
548 autoderefs: dereferences,
549 // this could be from an unsafe deref if we had
550 // a *mut/const [T; N]
551 from_unsafe_deref: reached_raw_pointer,
560 debug!("method_autoderef_steps: steps={:?} opt_bad_ty={:?}", steps, opt_bad_ty);
562 MethodAutoderefStepsResult {
563 steps: tcx.arena.alloc_from_iter(steps),
564 opt_bad_ty: opt_bad_ty.map(|ty| &*tcx.arena.alloc(ty)),
565 reached_recursion_limit: autoderef.reached_recursion_limit(),
569 impl<'a, 'tcx> ProbeContext<'a, 'tcx> {
571 fcx: &'a FnCtxt<'a, 'tcx>,
574 method_name: Option<Ident>,
575 return_type: Option<Ty<'tcx>>,
576 orig_steps_var_values: &'a OriginalQueryValues<'tcx>,
577 steps: &'tcx [CandidateStep<'tcx>],
578 scope_expr_id: hir::HirId,
579 ) -> ProbeContext<'a, 'tcx> {
586 inherent_candidates: Vec::new(),
587 extension_candidates: Vec::new(),
588 impl_dups: FxHashSet::default(),
589 orig_steps_var_values,
591 allow_similar_names: false,
592 private_candidate: None,
593 static_candidates: RefCell::new(Vec::new()),
594 unsatisfied_predicates: RefCell::new(Vec::new()),
599 fn reset(&mut self) {
600 self.inherent_candidates.clear();
601 self.extension_candidates.clear();
602 self.impl_dups.clear();
603 self.private_candidate = None;
604 self.static_candidates.borrow_mut().clear();
605 self.unsatisfied_predicates.borrow_mut().clear();
608 ///////////////////////////////////////////////////////////////////////////
609 // CANDIDATE ASSEMBLY
611 fn push_candidate(&mut self, candidate: Candidate<'tcx>, is_inherent: bool) {
612 let is_accessible = if let Some(name) = self.method_name {
613 let item = candidate.item;
614 let hir_id = self.tcx.hir().local_def_id_to_hir_id(self.body_id);
616 self.tcx.adjust_ident_and_get_scope(name, item.container_id(self.tcx), hir_id).1;
617 item.visibility(self.tcx).is_accessible_from(def_scope, self.tcx)
623 self.inherent_candidates.push(candidate);
625 self.extension_candidates.push(candidate);
627 } else if self.private_candidate.is_none() {
628 self.private_candidate =
629 Some((candidate.item.kind.as_def_kind(), candidate.item.def_id));
633 fn assemble_inherent_candidates(&mut self) {
634 for step in self.steps.iter() {
635 self.assemble_probe(&step.self_ty);
639 fn assemble_probe(&mut self, self_ty: &Canonical<'tcx, QueryResponse<'tcx, Ty<'tcx>>>) {
640 debug!("assemble_probe: self_ty={:?}", self_ty);
641 let raw_self_ty = self_ty.value.value;
642 match *raw_self_ty.kind() {
643 ty::Dynamic(data, ..) if let Some(p) = data.principal() => {
644 // Subtle: we can't use `instantiate_query_response` here: using it will
645 // commit to all of the type equalities assumed by inference going through
646 // autoderef (see the `method-probe-no-guessing` test).
648 // However, in this code, it is OK if we end up with an object type that is
649 // "more general" than the object type that we are evaluating. For *every*
650 // object type `MY_OBJECT`, a function call that goes through a trait-ref
651 // of the form `<MY_OBJECT as SuperTraitOf(MY_OBJECT)>::func` is a valid
652 // `ObjectCandidate`, and it should be discoverable "exactly" through one
653 // of the iterations in the autoderef loop, so there is no problem with it
654 // being discoverable in another one of these iterations.
656 // Using `instantiate_canonical_with_fresh_inference_vars` on our
657 // `Canonical<QueryResponse<Ty<'tcx>>>` and then *throwing away* the
658 // `CanonicalVarValues` will exactly give us such a generalization - it
659 // will still match the original object type, but it won't pollute our
660 // type variables in any form, so just do that!
661 let (QueryResponse { value: generalized_self_ty, .. }, _ignored_var_values) =
663 .instantiate_canonical_with_fresh_inference_vars(self.span, self_ty);
665 self.assemble_inherent_candidates_from_object(generalized_self_ty);
666 self.assemble_inherent_impl_candidates_for_type(p.def_id());
667 if self.tcx.has_attr(p.def_id(), sym::rustc_has_incoherent_inherent_impls) {
668 self.assemble_inherent_candidates_for_incoherent_ty(raw_self_ty);
672 let def_id = def.did();
673 self.assemble_inherent_impl_candidates_for_type(def_id);
674 if self.tcx.has_attr(def_id, sym::rustc_has_incoherent_inherent_impls) {
675 self.assemble_inherent_candidates_for_incoherent_ty(raw_self_ty);
678 ty::Foreign(did) => {
679 self.assemble_inherent_impl_candidates_for_type(did);
680 if self.tcx.has_attr(did, sym::rustc_has_incoherent_inherent_impls) {
681 self.assemble_inherent_candidates_for_incoherent_ty(raw_self_ty);
685 self.assemble_inherent_candidates_from_param(p);
698 | ty::Tuple(..) => self.assemble_inherent_candidates_for_incoherent_ty(raw_self_ty),
703 fn assemble_inherent_candidates_for_incoherent_ty(&mut self, self_ty: Ty<'tcx>) {
704 let Some(simp) = simplify_type(self.tcx, self_ty, TreatParams::AsInfer) else {
705 bug!("unexpected incoherent type: {:?}", self_ty)
707 for &impl_def_id in self.tcx.incoherent_impls(simp) {
708 self.assemble_inherent_impl_probe(impl_def_id);
712 fn assemble_inherent_impl_candidates_for_type(&mut self, def_id: DefId) {
713 let impl_def_ids = self.tcx.at(self.span).inherent_impls(def_id);
714 for &impl_def_id in impl_def_ids.iter() {
715 self.assemble_inherent_impl_probe(impl_def_id);
719 fn assemble_inherent_impl_probe(&mut self, impl_def_id: DefId) {
720 if !self.impl_dups.insert(impl_def_id) {
721 return; // already visited
724 debug!("assemble_inherent_impl_probe {:?}", impl_def_id);
726 for item in self.impl_or_trait_item(impl_def_id) {
727 if !self.has_applicable_self(&item) {
728 // No receiver declared. Not a candidate.
729 self.record_static_candidate(CandidateSource::Impl(impl_def_id));
733 let (impl_ty, impl_substs) = self.impl_ty_and_substs(impl_def_id);
734 let impl_ty = impl_ty.subst(self.tcx, impl_substs);
736 debug!("impl_ty: {:?}", impl_ty);
738 // Determine the receiver type that the method itself expects.
739 let (xform_self_ty, xform_ret_ty) = self.xform_self_ty(&item, impl_ty, impl_substs);
740 debug!("xform_self_ty: {:?}, xform_ret_ty: {:?}", xform_self_ty, xform_ret_ty);
742 // We can't use normalize_associated_types_in as it will pollute the
743 // fcx's fulfillment context after this probe is over.
744 // Note: we only normalize `xform_self_ty` here since the normalization
745 // of the return type can lead to inference results that prohibit
746 // valid candidates from being found, see issue #85671
747 // FIXME Postponing the normalization of the return type likely only hides a deeper bug,
748 // which might be caused by the `param_env` itself. The clauses of the `param_env`
749 // maybe shouldn't include `Param`s, but rather fresh variables or be canonicalized,
751 let cause = traits::ObligationCause::misc(self.span, self.body_id);
752 let InferOk { value: xform_self_ty, obligations } =
753 self.fcx.at(&cause, self.param_env).normalize(xform_self_ty);
756 "assemble_inherent_impl_probe after normalization: xform_self_ty = {:?}/{:?}",
757 xform_self_ty, xform_ret_ty
765 kind: InherentImplCandidate(impl_substs, obligations),
766 import_ids: smallvec![],
773 fn assemble_inherent_candidates_from_object(&mut self, self_ty: Ty<'tcx>) {
774 debug!("assemble_inherent_candidates_from_object(self_ty={:?})", self_ty);
776 let principal = match self_ty.kind() {
777 ty::Dynamic(ref data, ..) => Some(data),
780 .and_then(|data| data.principal())
784 "non-object {:?} in assemble_inherent_candidates_from_object",
789 // It is illegal to invoke a method on a trait instance that refers to
790 // the `Self` type. An [`ObjectSafetyViolation::SupertraitSelf`] error
791 // will be reported by `object_safety.rs` if the method refers to the
792 // `Self` type anywhere other than the receiver. Here, we use a
793 // substitution that replaces `Self` with the object type itself. Hence,
794 // a `&self` method will wind up with an argument type like `&dyn Trait`.
795 let trait_ref = principal.with_self_ty(self.tcx, self_ty);
796 self.elaborate_bounds(iter::once(trait_ref), |this, new_trait_ref, item| {
797 let new_trait_ref = this.erase_late_bound_regions(new_trait_ref);
799 let (xform_self_ty, xform_ret_ty) =
800 this.xform_self_ty(&item, new_trait_ref.self_ty(), new_trait_ref.substs);
806 kind: ObjectCandidate,
807 import_ids: smallvec![],
814 fn assemble_inherent_candidates_from_param(&mut self, param_ty: ty::ParamTy) {
815 // FIXME: do we want to commit to this behavior for param bounds?
816 debug!("assemble_inherent_candidates_from_param(param_ty={:?})", param_ty);
818 let bounds = self.param_env.caller_bounds().iter().filter_map(|predicate| {
819 let bound_predicate = predicate.kind();
820 match bound_predicate.skip_binder() {
821 ty::PredicateKind::Clause(ty::Clause::Trait(trait_predicate)) => {
822 match *trait_predicate.trait_ref.self_ty().kind() {
823 ty::Param(p) if p == param_ty => {
824 Some(bound_predicate.rebind(trait_predicate.trait_ref))
829 ty::PredicateKind::Subtype(..)
830 | ty::PredicateKind::Coerce(..)
831 | ty::PredicateKind::Clause(ty::Clause::Projection(..))
832 | ty::PredicateKind::Clause(ty::Clause::RegionOutlives(..))
833 | ty::PredicateKind::WellFormed(..)
834 | ty::PredicateKind::ObjectSafe(..)
835 | ty::PredicateKind::ClosureKind(..)
836 | ty::PredicateKind::Clause(ty::Clause::TypeOutlives(..))
837 | ty::PredicateKind::ConstEvaluatable(..)
838 | ty::PredicateKind::ConstEquate(..)
839 | ty::PredicateKind::Ambiguous
840 | ty::PredicateKind::TypeWellFormedFromEnv(..) => None,
844 self.elaborate_bounds(bounds, |this, poly_trait_ref, item| {
845 let trait_ref = this.erase_late_bound_regions(poly_trait_ref);
847 let (xform_self_ty, xform_ret_ty) =
848 this.xform_self_ty(&item, trait_ref.self_ty(), trait_ref.substs);
850 // Because this trait derives from a where-clause, it
851 // should not contain any inference variables or other
852 // artifacts. This means it is safe to put into the
853 // `WhereClauseCandidate` and (eventually) into the
854 // `WhereClausePick`.
855 assert!(!trait_ref.substs.needs_infer());
862 kind: WhereClauseCandidate(poly_trait_ref),
863 import_ids: smallvec![],
870 // Do a search through a list of bounds, using a callback to actually
871 // create the candidates.
872 fn elaborate_bounds<F>(
874 bounds: impl Iterator<Item = ty::PolyTraitRef<'tcx>>,
877 F: for<'b> FnMut(&mut ProbeContext<'b, 'tcx>, ty::PolyTraitRef<'tcx>, ty::AssocItem),
880 for bound_trait_ref in traits::transitive_bounds(tcx, bounds) {
881 debug!("elaborate_bounds(bound_trait_ref={:?})", bound_trait_ref);
882 for item in self.impl_or_trait_item(bound_trait_ref.def_id()) {
883 if !self.has_applicable_self(&item) {
884 self.record_static_candidate(CandidateSource::Trait(bound_trait_ref.def_id()));
886 mk_cand(self, bound_trait_ref, item);
892 fn assemble_extension_candidates_for_traits_in_scope(&mut self) {
893 let mut duplicates = FxHashSet::default();
894 let opt_applicable_traits = self.tcx.in_scope_traits(self.scope_expr_id);
895 if let Some(applicable_traits) = opt_applicable_traits {
896 for trait_candidate in applicable_traits.iter() {
897 let trait_did = trait_candidate.def_id;
898 if duplicates.insert(trait_did) {
899 self.assemble_extension_candidates_for_trait(
900 &trait_candidate.import_ids,
908 fn assemble_extension_candidates_for_all_traits(&mut self) {
909 let mut duplicates = FxHashSet::default();
910 for trait_info in suggest::all_traits(self.tcx) {
911 if duplicates.insert(trait_info.def_id) {
912 self.assemble_extension_candidates_for_trait(&smallvec![], trait_info.def_id);
917 fn matches_return_type(
919 method: &ty::AssocItem,
920 self_ty: Option<Ty<'tcx>>,
924 ty::AssocKind::Fn => self.probe(|_| {
925 let substs = self.fresh_substs_for_item(self.span, method.def_id);
926 let fty = self.tcx.fn_sig(method.def_id).subst(self.tcx, substs);
927 let fty = self.replace_bound_vars_with_fresh_vars(self.span, infer::FnCall, fty);
929 if let Some(self_ty) = self_ty {
931 .at(&ObligationCause::dummy(), self.param_env)
932 .sup(fty.inputs()[0], self_ty)
938 self.can_sub(self.param_env, fty.output(), expected).is_ok()
944 fn assemble_extension_candidates_for_trait(
946 import_ids: &SmallVec<[LocalDefId; 1]>,
949 debug!("assemble_extension_candidates_for_trait(trait_def_id={:?})", trait_def_id);
950 let trait_substs = self.fresh_item_substs(trait_def_id);
951 let trait_ref = self.tcx.mk_trait_ref(trait_def_id, trait_substs);
953 if self.tcx.is_trait_alias(trait_def_id) {
954 // For trait aliases, assume all supertraits are relevant.
955 let bounds = iter::once(ty::Binder::dummy(trait_ref));
956 self.elaborate_bounds(bounds, |this, new_trait_ref, item| {
957 let new_trait_ref = this.erase_late_bound_regions(new_trait_ref);
959 let (xform_self_ty, xform_ret_ty) =
960 this.xform_self_ty(&item, new_trait_ref.self_ty(), new_trait_ref.substs);
966 import_ids: import_ids.clone(),
967 kind: TraitCandidate(new_trait_ref),
973 debug_assert!(self.tcx.is_trait(trait_def_id));
974 if self.tcx.trait_is_auto(trait_def_id) {
977 for item in self.impl_or_trait_item(trait_def_id) {
978 // Check whether `trait_def_id` defines a method with suitable name.
979 if !self.has_applicable_self(&item) {
980 debug!("method has inapplicable self");
981 self.record_static_candidate(CandidateSource::Trait(trait_def_id));
985 let (xform_self_ty, xform_ret_ty) =
986 self.xform_self_ty(&item, trait_ref.self_ty(), trait_substs);
992 import_ids: import_ids.clone(),
993 kind: TraitCandidate(trait_ref),
1001 fn candidate_method_names(
1003 candidate_filter: impl Fn(&ty::AssocItem) -> bool,
1005 let mut set = FxHashSet::default();
1006 let mut names: Vec<_> = self
1007 .inherent_candidates
1009 .chain(&self.extension_candidates)
1010 .filter(|candidate| candidate_filter(&candidate.item))
1011 .filter(|candidate| {
1012 if let Some(return_ty) = self.return_type {
1013 self.matches_return_type(&candidate.item, None, return_ty)
1018 .map(|candidate| candidate.item.ident(self.tcx))
1019 .filter(|&name| set.insert(name))
1022 // Sort them by the name so we have a stable result.
1023 names.sort_by(|a, b| a.as_str().partial_cmp(b.as_str()).unwrap());
1027 ///////////////////////////////////////////////////////////////////////////
1028 // THE ACTUAL SEARCH
1030 fn pick(mut self) -> PickResult<'tcx> {
1031 assert!(self.method_name.is_some());
1033 if let Some(r) = self.pick_core() {
1037 debug!("pick: actual search failed, assemble diagnostics");
1039 let static_candidates = std::mem::take(self.static_candidates.get_mut());
1040 let private_candidate = self.private_candidate.take();
1041 let unsatisfied_predicates = std::mem::take(self.unsatisfied_predicates.get_mut());
1043 // things failed, so lets look at all traits, for diagnostic purposes now:
1046 let span = self.span;
1049 self.assemble_extension_candidates_for_all_traits();
1051 let out_of_scope_traits = match self.pick_core() {
1052 Some(Ok(p)) => vec![p.item.container_id(self.tcx)],
1053 Some(Err(MethodError::Ambiguity(v))) => v
1055 .map(|source| match source {
1056 CandidateSource::Trait(id) => id,
1057 CandidateSource::Impl(impl_id) => match tcx.trait_id_of_impl(impl_id) {
1059 None => span_bug!(span, "found inherent method when looking at traits"),
1063 Some(Err(MethodError::NoMatch(NoMatchData {
1064 out_of_scope_traits: others, ..
1066 assert!(others.is_empty());
1072 if let Some((kind, def_id)) = private_candidate {
1073 return Err(MethodError::PrivateMatch(kind, def_id, out_of_scope_traits));
1075 let similar_candidate = self.probe_for_similar_candidate()?;
1077 Err(MethodError::NoMatch(NoMatchData {
1079 unsatisfied_predicates,
1080 out_of_scope_traits,
1086 fn pick_core(&self) -> Option<PickResult<'tcx>> {
1087 let pick = self.pick_all_method(Some(&mut vec![]));
1089 // In this case unstable picking is done by `pick_method`.
1090 if !self.tcx.sess.opts.unstable_opts.pick_stable_methods_before_any_unstable {
1095 return self.pick_all_method(None);
1102 mut unstable_candidates: Option<&mut Vec<(Candidate<'tcx>, Symbol)>>,
1103 ) -> Option<PickResult<'tcx>> {
1107 debug!("pick_all_method: step={:?}", step);
1108 // skip types that are from a type error or that would require dereferencing
1110 !step.self_ty.references_error() && !step.from_unsafe_deref
1113 let InferOk { value: self_ty, obligations: _ } = self
1115 .probe_instantiate_query_response(
1117 &self.orig_steps_var_values,
1120 .unwrap_or_else(|_| {
1121 span_bug!(self.span, "{:?} was applicable but now isn't?", step.self_ty)
1123 self.pick_by_value_method(step, self_ty, unstable_candidates.as_deref_mut())
1125 self.pick_autorefd_method(
1128 hir::Mutability::Not,
1129 unstable_candidates.as_deref_mut(),
1132 self.pick_autorefd_method(
1135 hir::Mutability::Mut,
1136 unstable_candidates.as_deref_mut(),
1140 self.pick_const_ptr_method(
1143 unstable_candidates.as_deref_mut(),
1150 /// For each type `T` in the step list, this attempts to find a method where
1151 /// the (transformed) self type is exactly `T`. We do however do one
1152 /// transformation on the adjustment: if we are passing a region pointer in,
1153 /// we will potentially *reborrow* it to a shorter lifetime. This allows us
1154 /// to transparently pass `&mut` pointers, in particular, without consuming
1155 /// them for their entire lifetime.
1156 fn pick_by_value_method(
1158 step: &CandidateStep<'tcx>,
1160 unstable_candidates: Option<&mut Vec<(Candidate<'tcx>, Symbol)>>,
1161 ) -> Option<PickResult<'tcx>> {
1166 self.pick_method(self_ty, unstable_candidates).map(|r| {
1168 pick.autoderefs = step.autoderefs;
1170 // Insert a `&*` or `&mut *` if this is a reference type:
1171 if let ty::Ref(_, _, mutbl) = *step.self_ty.value.value.kind() {
1172 pick.autoderefs += 1;
1173 pick.autoref_or_ptr_adjustment = Some(AutorefOrPtrAdjustment::Autoref {
1175 unsize: pick.autoref_or_ptr_adjustment.map_or(false, |a| a.get_unsize()),
1184 fn pick_autorefd_method(
1186 step: &CandidateStep<'tcx>,
1188 mutbl: hir::Mutability,
1189 unstable_candidates: Option<&mut Vec<(Candidate<'tcx>, Symbol)>>,
1190 ) -> Option<PickResult<'tcx>> {
1193 // In general, during probing we erase regions.
1194 let region = tcx.lifetimes.re_erased;
1196 let autoref_ty = tcx.mk_ref(region, ty::TypeAndMut { ty: self_ty, mutbl });
1197 self.pick_method(autoref_ty, unstable_candidates).map(|r| {
1199 pick.autoderefs = step.autoderefs;
1200 pick.autoref_or_ptr_adjustment =
1201 Some(AutorefOrPtrAdjustment::Autoref { mutbl, unsize: step.unsize });
1207 /// If `self_ty` is `*mut T` then this picks `*const T` methods. The reason why we have a
1208 /// special case for this is because going from `*mut T` to `*const T` with autoderefs and
1209 /// autorefs would require dereferencing the pointer, which is not safe.
1210 fn pick_const_ptr_method(
1212 step: &CandidateStep<'tcx>,
1214 unstable_candidates: Option<&mut Vec<(Candidate<'tcx>, Symbol)>>,
1215 ) -> Option<PickResult<'tcx>> {
1216 // Don't convert an unsized reference to ptr
1221 let &ty::RawPtr(ty::TypeAndMut { ty, mutbl: hir::Mutability::Mut }) = self_ty.kind() else {
1225 let const_self_ty = ty::TypeAndMut { ty, mutbl: hir::Mutability::Not };
1226 let const_ptr_ty = self.tcx.mk_ptr(const_self_ty);
1227 self.pick_method(const_ptr_ty, unstable_candidates).map(|r| {
1229 pick.autoderefs = step.autoderefs;
1230 pick.autoref_or_ptr_adjustment = Some(AutorefOrPtrAdjustment::ToConstPtr);
1236 fn pick_method_with_unstable(&self, self_ty: Ty<'tcx>) -> Option<PickResult<'tcx>> {
1237 debug!("pick_method_with_unstable(self_ty={})", self.ty_to_string(self_ty));
1239 let mut possibly_unsatisfied_predicates = Vec::new();
1241 for (kind, candidates) in
1242 &[("inherent", &self.inherent_candidates), ("extension", &self.extension_candidates)]
1244 debug!("searching {} candidates", kind);
1245 let res = self.consider_candidates(
1248 &mut possibly_unsatisfied_predicates,
1256 for (kind, candidates) in
1257 &[("inherent", &self.inherent_candidates), ("extension", &self.extension_candidates)]
1259 debug!("searching unstable {kind} candidates");
1260 let res = self.consider_candidates(
1263 &mut possibly_unsatisfied_predicates,
1271 self.unsatisfied_predicates.borrow_mut().extend(possibly_unsatisfied_predicates);
1278 mut unstable_candidates: Option<&mut Vec<(Candidate<'tcx>, Symbol)>>,
1279 ) -> Option<PickResult<'tcx>> {
1280 if !self.tcx.sess.opts.unstable_opts.pick_stable_methods_before_any_unstable {
1281 return self.pick_method_with_unstable(self_ty);
1284 debug!("pick_method(self_ty={})", self.ty_to_string(self_ty));
1286 let mut possibly_unsatisfied_predicates = Vec::new();
1288 for (kind, candidates) in
1289 &[("inherent", &self.inherent_candidates), ("extension", &self.extension_candidates)]
1291 debug!("searching {} candidates", kind);
1292 let res = self.consider_candidates(
1295 &mut possibly_unsatisfied_predicates,
1296 unstable_candidates.as_deref_mut(),
1298 if let Some(pick) = res {
1303 // `pick_method` may be called twice for the same self_ty if no stable methods
1304 // match. Only extend once.
1305 if unstable_candidates.is_some() {
1306 self.unsatisfied_predicates.borrow_mut().extend(possibly_unsatisfied_predicates);
1311 fn consider_candidates(
1314 candidates: &[Candidate<'tcx>],
1315 possibly_unsatisfied_predicates: &mut Vec<(
1316 ty::Predicate<'tcx>,
1317 Option<ty::Predicate<'tcx>>,
1318 Option<ObligationCause<'tcx>>,
1320 mut unstable_candidates: Option<&mut Vec<(Candidate<'tcx>, Symbol)>>,
1321 ) -> Option<PickResult<'tcx>> {
1322 let mut applicable_candidates: Vec<_> = candidates
1325 (probe, self.consider_probe(self_ty, probe, possibly_unsatisfied_predicates))
1327 .filter(|&(_, status)| status != ProbeResult::NoMatch)
1330 debug!("applicable_candidates: {:?}", applicable_candidates);
1332 if applicable_candidates.len() > 1 {
1334 self.collapse_candidates_to_trait_pick(self_ty, &applicable_candidates)
1336 return Some(Ok(pick));
1340 if let Some(uc) = &mut unstable_candidates {
1341 applicable_candidates.retain(|&(candidate, _)| {
1342 if let stability::EvalResult::Deny { feature, .. } =
1343 self.tcx.eval_stability(candidate.item.def_id, None, self.span, None)
1345 uc.push((candidate.clone(), feature));
1352 if applicable_candidates.len() > 1 {
1353 let sources = candidates.iter().map(|p| self.candidate_source(p, self_ty)).collect();
1354 return Some(Err(MethodError::Ambiguity(sources)));
1357 applicable_candidates.pop().map(|(probe, status)| {
1358 if status == ProbeResult::Match {
1360 .to_unadjusted_pick(self_ty, unstable_candidates.cloned().unwrap_or_default()))
1362 Err(MethodError::BadReturnType)
1368 impl<'tcx> Pick<'tcx> {
1369 /// In case there were unstable name collisions, emit them as a lint.
1370 /// Checks whether two picks do not refer to the same trait item for the same `Self` type.
1371 /// Only useful for comparisons of picks in order to improve diagnostics.
1372 /// Do not use for type checking.
1373 pub fn differs_from(&self, other: &Self) -> bool {
1381 trait_item_def_id: _,
1382 fn_has_self_parameter: _,
1387 autoref_or_ptr_adjustment: _,
1389 unstable_candidates: _,
1391 self_ty != other.self_ty || def_id != other.item.def_id
1394 /// In case there were unstable name collisions, emit them as a lint.
1395 pub fn maybe_emit_unstable_name_collision_hint(
1399 scope_expr_id: hir::HirId,
1401 if self.unstable_candidates.is_empty() {
1404 let def_kind = self.item.kind.as_def_kind();
1405 tcx.struct_span_lint_hir(
1406 lint::builtin::UNSTABLE_NAME_COLLISIONS,
1410 "{} {} with this name may be added to the standard library in the future",
1412 def_kind.descr(self.item.def_id),
1415 match (self.item.kind, self.item.container) {
1416 (ty::AssocKind::Fn, _) => {
1417 // FIXME: This should be a `span_suggestion` instead of `help`
1418 // However `self.span` only
1419 // highlights the method name, so we can't use it. Also consider reusing
1420 // the code from `report_method_error()`.
1422 "call with fully qualified syntax `{}(...)` to keep using the current \
1424 tcx.def_path_str(self.item.def_id),
1427 (ty::AssocKind::Const, ty::AssocItemContainer::TraitContainer) => {
1428 let def_id = self.item.container_id(tcx);
1429 lint.span_suggestion(
1431 "use the fully qualified path to the associated const",
1435 tcx.def_path_str(def_id),
1438 Applicability::MachineApplicable,
1443 if tcx.sess.is_nightly_build() {
1444 for (candidate, feature) in &self.unstable_candidates {
1446 "add `#![feature({})]` to the crate attributes to enable `{}`",
1448 tcx.def_path_str(candidate.item.def_id),
1459 impl<'a, 'tcx> ProbeContext<'a, 'tcx> {
1460 fn select_trait_candidate(
1462 trait_ref: ty::TraitRef<'tcx>,
1463 ) -> traits::SelectionResult<'tcx, traits::Selection<'tcx>> {
1464 let cause = traits::ObligationCause::misc(self.span, self.body_id);
1465 let predicate = ty::Binder::dummy(trait_ref);
1466 let obligation = traits::Obligation::new(self.tcx, cause, self.param_env, predicate);
1467 traits::SelectionContext::new(self).select(&obligation)
1470 fn candidate_source(&self, candidate: &Candidate<'tcx>, self_ty: Ty<'tcx>) -> CandidateSource {
1471 match candidate.kind {
1472 InherentImplCandidate(..) => {
1473 CandidateSource::Impl(candidate.item.container_id(self.tcx))
1475 ObjectCandidate | WhereClauseCandidate(_) => {
1476 CandidateSource::Trait(candidate.item.container_id(self.tcx))
1478 TraitCandidate(trait_ref) => self.probe(|_| {
1480 .at(&ObligationCause::dummy(), self.param_env)
1481 .define_opaque_types(false)
1482 .sup(candidate.xform_self_ty, self_ty);
1483 match self.select_trait_candidate(trait_ref) {
1484 Ok(Some(traits::ImplSource::UserDefined(ref impl_data))) => {
1485 // If only a single impl matches, make the error message point
1487 CandidateSource::Impl(impl_data.impl_def_id)
1489 _ => CandidateSource::Trait(candidate.item.container_id(self.tcx)),
1498 probe: &Candidate<'tcx>,
1499 possibly_unsatisfied_predicates: &mut Vec<(
1500 ty::Predicate<'tcx>,
1501 Option<ty::Predicate<'tcx>>,
1502 Option<ObligationCause<'tcx>>,
1505 debug!("consider_probe: self_ty={:?} probe={:?}", self_ty, probe);
1508 // First check that the self type can be related.
1509 let sub_obligations = match self
1510 .at(&ObligationCause::dummy(), self.param_env)
1511 .define_opaque_types(false)
1512 .sup(probe.xform_self_ty, self_ty)
1514 Ok(InferOk { obligations, value: () }) => obligations,
1516 debug!("--> cannot relate self-types {:?}", err);
1517 return ProbeResult::NoMatch;
1521 let mut result = ProbeResult::Match;
1522 let mut xform_ret_ty = probe.xform_ret_ty;
1523 debug!(?xform_ret_ty);
1525 let cause = traits::ObligationCause::misc(self.span, self.body_id);
1527 let mut parent_pred = None;
1529 // If so, impls may carry other conditions (e.g., where
1530 // clauses) that must be considered. Make sure that those
1531 // match as well (or at least may match, sometimes we
1532 // don't have enough information to fully evaluate).
1534 InherentImplCandidate(ref substs, ref ref_obligations) => {
1535 // `xform_ret_ty` hasn't been normalized yet, only `xform_self_ty`,
1536 // see the reasons mentioned in the comments in `assemble_inherent_impl_probe`
1537 // for why this is necessary
1539 value: normalized_xform_ret_ty,
1540 obligations: normalization_obligations,
1541 } = self.fcx.at(&cause, self.param_env).normalize(xform_ret_ty);
1542 xform_ret_ty = normalized_xform_ret_ty;
1543 debug!("xform_ret_ty after normalization: {:?}", xform_ret_ty);
1545 // Check whether the impl imposes obligations we have to worry about.
1546 let impl_def_id = probe.item.container_id(self.tcx);
1547 let impl_bounds = self.tcx.predicates_of(impl_def_id);
1548 let impl_bounds = impl_bounds.instantiate(self.tcx, substs);
1550 let InferOk { value: impl_bounds, obligations: norm_obligations } =
1551 self.fcx.at(&cause, self.param_env).normalize(impl_bounds);
1553 // Convert the bounds into obligations.
1554 let impl_obligations = traits::predicates_for_generics(
1556 let misc = traits::ObligationCause::misc(span, self.body_id);
1557 let parent_trait_pred = ty::Binder::dummy(ty::TraitPredicate {
1558 trait_ref: ty::TraitRef::from_method(self.tcx, impl_def_id, substs),
1559 constness: ty::BoundConstness::NotConst,
1560 polarity: ty::ImplPolarity::Positive,
1562 misc.derived_cause(parent_trait_pred, |derived| {
1563 traits::ImplDerivedObligation(Box::new(
1564 traits::ImplDerivedObligationCause {
1576 let candidate_obligations = impl_obligations
1577 .chain(norm_obligations.into_iter())
1578 .chain(ref_obligations.iter().cloned())
1579 .chain(normalization_obligations.into_iter());
1581 // Evaluate those obligations to see if they might possibly hold.
1582 for o in candidate_obligations {
1583 let o = self.resolve_vars_if_possible(o);
1584 if !self.predicate_may_hold(&o) {
1585 result = ProbeResult::NoMatch;
1586 let parent_o = o.clone();
1587 let implied_obligations =
1588 traits::elaborate_obligations(self.tcx, vec![o]);
1589 for o in implied_obligations {
1590 let parent = if o == parent_o {
1593 if o.predicate.to_opt_poly_trait_pred().map(|p| p.def_id())
1594 == self.tcx.lang_items().sized_trait()
1596 // We don't care to talk about implicit `Sized` bounds.
1599 Some(parent_o.predicate)
1601 if !self.predicate_may_hold(&o) {
1602 possibly_unsatisfied_predicates.push((
1613 ObjectCandidate | WhereClauseCandidate(..) => {
1614 // These have no additional conditions to check.
1617 TraitCandidate(trait_ref) => {
1618 if let Some(method_name) = self.method_name {
1619 // Some trait methods are excluded for arrays before 2021.
1620 // (`array.into_iter()` wants a slice iterator for compatibility.)
1621 if self_ty.is_array() && !method_name.span.rust_2021() {
1622 let trait_def = self.tcx.trait_def(trait_ref.def_id);
1623 if trait_def.skip_array_during_method_dispatch {
1624 return ProbeResult::NoMatch;
1629 ty::Binder::dummy(trait_ref).without_const().to_predicate(self.tcx);
1630 parent_pred = Some(predicate);
1632 traits::Obligation::new(self.tcx, cause.clone(), self.param_env, predicate);
1633 if !self.predicate_may_hold(&obligation) {
1634 result = ProbeResult::NoMatch;
1636 match self.select_trait_candidate(trait_ref) {
1637 Err(_) => return true,
1638 Ok(Some(impl_source))
1639 if !impl_source.borrow_nested_obligations().is_empty() =>
1641 for obligation in impl_source.borrow_nested_obligations() {
1642 // Determine exactly which obligation wasn't met, so
1643 // that we can give more context in the error.
1644 if !self.predicate_may_hold(obligation) {
1645 let nested_predicate =
1646 self.resolve_vars_if_possible(obligation.predicate);
1648 self.resolve_vars_if_possible(predicate);
1649 let p = if predicate == nested_predicate {
1650 // Avoid "`MyStruct: Foo` which is required by
1651 // `MyStruct: Foo`" in E0599.
1656 possibly_unsatisfied_predicates.push((
1659 Some(obligation.cause.clone()),
1665 // Some nested subobligation of this predicate
1667 let predicate = self.resolve_vars_if_possible(predicate);
1668 possibly_unsatisfied_predicates.push((predicate, None, None));
1673 // This candidate's primary obligation doesn't even
1674 // select - don't bother registering anything in
1675 // `potentially_unsatisfied_predicates`.
1676 return ProbeResult::NoMatch;
1682 // Evaluate those obligations to see if they might possibly hold.
1683 for o in sub_obligations {
1684 let o = self.resolve_vars_if_possible(o);
1685 if !self.predicate_may_hold(&o) {
1686 result = ProbeResult::NoMatch;
1687 possibly_unsatisfied_predicates.push((o.predicate, parent_pred, Some(o.cause)));
1691 if let ProbeResult::Match = result
1692 && let Some(return_ty) = self.return_type
1693 && let Some(mut xform_ret_ty) = xform_ret_ty
1695 // `xform_ret_ty` has only been normalized for `InherentImplCandidate`.
1696 // We don't normalize the other candidates for perf/backwards-compat reasons...
1697 // but `self.return_type` is only set on the diagnostic-path, so we
1698 // should be okay doing it here.
1699 if !matches!(probe.kind, InherentImplCandidate(..)) {
1701 value: normalized_xform_ret_ty,
1702 obligations: normalization_obligations,
1703 } = self.fcx.at(&cause, self.param_env).normalize(xform_ret_ty);
1704 xform_ret_ty = normalized_xform_ret_ty;
1705 debug!("xform_ret_ty after normalization: {:?}", xform_ret_ty);
1706 // Evaluate those obligations to see if they might possibly hold.
1707 for o in normalization_obligations {
1708 let o = self.resolve_vars_if_possible(o);
1709 if !self.predicate_may_hold(&o) {
1710 result = ProbeResult::NoMatch;
1711 possibly_unsatisfied_predicates.push((
1721 "comparing return_ty {:?} with xform ret ty {:?}",
1722 return_ty, xform_ret_ty
1724 if let ProbeResult::Match = result
1726 .at(&ObligationCause::dummy(), self.param_env)
1727 .define_opaque_types(false)
1728 .sup(return_ty, xform_ret_ty)
1731 result = ProbeResult::BadReturnType;
1739 /// Sometimes we get in a situation where we have multiple probes that are all impls of the
1740 /// same trait, but we don't know which impl to use. In this case, since in all cases the
1741 /// external interface of the method can be determined from the trait, it's ok not to decide.
1742 /// We can basically just collapse all of the probes for various impls into one where-clause
1743 /// probe. This will result in a pending obligation so when more type-info is available we can
1744 /// make the final decision.
1746 /// Example (`tests/ui/method-two-trait-defer-resolution-1.rs`):
1748 /// ```ignore (illustrative)
1749 /// trait Foo { ... }
1750 /// impl Foo for Vec<i32> { ... }
1751 /// impl Foo for Vec<usize> { ... }
1754 /// Now imagine the receiver is `Vec<_>`. It doesn't really matter at this time which impl we
1755 /// use, so it's ok to just commit to "using the method from the trait Foo".
1756 fn collapse_candidates_to_trait_pick(
1759 probes: &[(&Candidate<'tcx>, ProbeResult)],
1760 ) -> Option<Pick<'tcx>> {
1761 // Do all probes correspond to the same trait?
1762 let container = probes[0].0.item.trait_container(self.tcx)?;
1763 for (p, _) in &probes[1..] {
1764 let p_container = p.item.trait_container(self.tcx)?;
1765 if p_container != container {
1770 // FIXME: check the return type here somehow.
1771 // If so, just use this trait and call it a day.
1773 item: probes[0].0.item,
1775 import_ids: probes[0].0.import_ids.clone(),
1777 autoref_or_ptr_adjustment: None,
1779 unstable_candidates: vec![],
1783 /// Similarly to `probe_for_return_type`, this method attempts to find the best matching
1784 /// candidate method where the method name may have been misspelled. Similarly to other
1785 /// Levenshtein based suggestions, we provide at most one such suggestion.
1786 fn probe_for_similar_candidate(&mut self) -> Result<Option<ty::AssocItem>, MethodError<'tcx>> {
1787 debug!("probing for method names similar to {:?}", self.method_name);
1789 let steps = self.steps.clone();
1791 let mut pcx = ProbeContext::new(
1797 &self.orig_steps_var_values,
1801 pcx.allow_similar_names = true;
1802 pcx.assemble_inherent_candidates();
1804 let method_names = pcx.candidate_method_names(|_| true);
1805 pcx.allow_similar_names = false;
1806 let applicable_close_candidates: Vec<ty::AssocItem> = method_names
1808 .filter_map(|&method_name| {
1810 pcx.method_name = Some(method_name);
1811 pcx.assemble_inherent_candidates();
1812 pcx.pick_core().and_then(|pick| pick.ok()).map(|pick| pick.item)
1816 if applicable_close_candidates.is_empty() {
1820 let names = applicable_close_candidates
1822 .map(|cand| cand.name)
1823 .collect::<Vec<Symbol>>();
1824 find_best_match_for_name_with_substrings(
1826 self.method_name.unwrap().name,
1831 applicable_close_candidates
1833 .find(|cand| self.matches_by_doc_alias(cand.def_id))
1834 .map(|cand| cand.name)
1837 Ok(applicable_close_candidates.into_iter().find(|method| method.name == best_name))
1842 ///////////////////////////////////////////////////////////////////////////
1844 fn has_applicable_self(&self, item: &ty::AssocItem) -> bool {
1845 // "Fast track" -- check for usage of sugar when in method call
1848 // In Path mode (i.e., resolving a value like `T::next`), consider any
1849 // associated value (i.e., methods, constants) but not types.
1851 Mode::MethodCall => item.fn_has_self_parameter,
1852 Mode::Path => match item.kind {
1853 ty::AssocKind::Type => false,
1854 ty::AssocKind::Fn | ty::AssocKind::Const => true,
1857 // FIXME -- check for types that deref to `Self`,
1858 // like `Rc<Self>` and so on.
1860 // Note also that the current code will break if this type
1861 // includes any of the type parameters defined on the method
1862 // -- but this could be overcome.
1865 fn record_static_candidate(&self, source: CandidateSource) {
1866 self.static_candidates.borrow_mut().push(source);
1869 #[instrument(level = "debug", skip(self))]
1872 item: &ty::AssocItem,
1874 substs: SubstsRef<'tcx>,
1875 ) -> (Ty<'tcx>, Option<Ty<'tcx>>) {
1876 if item.kind == ty::AssocKind::Fn && self.mode == Mode::MethodCall {
1877 let sig = self.xform_method_sig(item.def_id, substs);
1878 (sig.inputs()[0], Some(sig.output()))
1884 #[instrument(level = "debug", skip(self))]
1885 fn xform_method_sig(&self, method: DefId, substs: SubstsRef<'tcx>) -> ty::FnSig<'tcx> {
1886 let fn_sig = self.tcx.fn_sig(method);
1889 assert!(!substs.has_escaping_bound_vars());
1891 // It is possible for type parameters or early-bound lifetimes
1892 // to appear in the signature of `self`. The substitutions we
1893 // are given do not include type/lifetime parameters for the
1894 // method yet. So create fresh variables here for those too,
1895 // if there are any.
1896 let generics = self.tcx.generics_of(method);
1897 assert_eq!(substs.len(), generics.parent_count as usize);
1899 let xform_fn_sig = if generics.params.is_empty() {
1900 fn_sig.subst(self.tcx, substs)
1902 let substs = InternalSubsts::for_item(self.tcx, method, |param, _| {
1903 let i = param.index as usize;
1904 if i < substs.len() {
1908 GenericParamDefKind::Lifetime => {
1909 // In general, during probe we erase regions.
1910 self.tcx.lifetimes.re_erased.into()
1912 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const { .. } => {
1913 self.var_for_def(self.span, param)
1918 fn_sig.subst(self.tcx, substs)
1921 self.erase_late_bound_regions(xform_fn_sig)
1924 /// Gets the type of an impl and generate substitutions with inference vars.
1925 fn impl_ty_and_substs(
1928 ) -> (ty::EarlyBinder<Ty<'tcx>>, SubstsRef<'tcx>) {
1929 (self.tcx.bound_type_of(impl_def_id), self.fresh_item_substs(impl_def_id))
1932 fn fresh_item_substs(&self, def_id: DefId) -> SubstsRef<'tcx> {
1933 InternalSubsts::for_item(self.tcx, def_id, |param, _| match param.kind {
1934 GenericParamDefKind::Lifetime => self.tcx.lifetimes.re_erased.into(),
1935 GenericParamDefKind::Type { .. } => self
1936 .next_ty_var(TypeVariableOrigin {
1937 kind: TypeVariableOriginKind::SubstitutionPlaceholder,
1938 span: self.tcx.def_span(def_id),
1941 GenericParamDefKind::Const { .. } => {
1942 let span = self.tcx.def_span(def_id);
1943 let origin = ConstVariableOrigin {
1944 kind: ConstVariableOriginKind::SubstitutionPlaceholder,
1947 self.next_const_var(self.tcx.type_of(param.def_id), origin).into()
1952 /// Replaces late-bound-regions bound by `value` with `'static` using
1953 /// `ty::erase_late_bound_regions`.
1955 /// This is only a reasonable thing to do during the *probe* phase, not the *confirm* phase, of
1956 /// method matching. It is reasonable during the probe phase because we don't consider region
1957 /// relationships at all. Therefore, we can just replace all the region variables with 'static
1958 /// rather than creating fresh region variables. This is nice for two reasons:
1960 /// 1. Because the numbers of the region variables would otherwise be fairly unique to this
1961 /// particular method call, it winds up creating fewer types overall, which helps for memory
1962 /// usage. (Admittedly, this is a rather small effect, though measurable.)
1964 /// 2. It makes it easier to deal with higher-ranked trait bounds, because we can replace any
1965 /// late-bound regions with 'static. Otherwise, if we were going to replace late-bound
1966 /// regions with actual region variables as is proper, we'd have to ensure that the same
1967 /// region got replaced with the same variable, which requires a bit more coordination
1968 /// and/or tracking the substitution and
1970 fn erase_late_bound_regions<T>(&self, value: ty::Binder<'tcx, T>) -> T
1972 T: TypeFoldable<'tcx>,
1974 self.tcx.erase_late_bound_regions(value)
1977 /// Determine if the given associated item type is relevant in the current context.
1978 fn is_relevant_kind_for_mode(&self, kind: ty::AssocKind) -> bool {
1979 match (self.mode, kind) {
1980 (Mode::MethodCall, ty::AssocKind::Fn) => true,
1981 (Mode::Path, ty::AssocKind::Const | ty::AssocKind::Fn) => true,
1986 /// Determine if the associated item withe the given DefId matches
1987 /// the desired name via a doc alias.
1988 fn matches_by_doc_alias(&self, def_id: DefId) -> bool {
1989 let Some(name) = self.method_name else { return false; };
1990 let Some(local_def_id) = def_id.as_local() else { return false; };
1991 let hir_id = self.fcx.tcx.hir().local_def_id_to_hir_id(local_def_id);
1992 let attrs = self.fcx.tcx.hir().attrs(hir_id);
1994 let sym::doc = attr.name_or_empty() else { continue; };
1995 let Some(values) = attr.meta_item_list() else { continue; };
1997 if v.name_or_empty() != sym::alias {
2000 if let Some(nested) = v.meta_item_list() {
2001 // #[doc(alias("foo", "bar"))]
2003 if let Some(lit) = n.lit() && name.as_str() == lit.symbol.as_str() {
2007 } else if let Some(meta) = v.meta_item()
2008 && let Some(lit) = meta.name_value_literal()
2009 && name.as_str() == lit.symbol.as_str() {
2010 // #[doc(alias = "foo")]
2018 /// Finds the method with the appropriate name (or return type, as the case may be). If
2019 /// `allow_similar_names` is set, find methods with close-matching names.
2020 // The length of the returned iterator is nearly always 0 or 1 and this
2021 // method is fairly hot.
2022 fn impl_or_trait_item(&self, def_id: DefId) -> SmallVec<[ty::AssocItem; 1]> {
2023 if let Some(name) = self.method_name {
2024 if self.allow_similar_names {
2025 let max_dist = max(name.as_str().len(), 3) / 3;
2027 .associated_items(def_id)
2028 .in_definition_order()
2030 if !self.is_relevant_kind_for_mode(x.kind) {
2033 if self.matches_by_doc_alias(x.def_id) {
2036 match lev_distance_with_substrings(name.as_str(), x.name.as_str(), max_dist)
2046 .associated_value(def_id, name)
2047 .filter(|x| self.is_relevant_kind_for_mode(x.kind))
2048 .map_or_else(SmallVec::new, |x| SmallVec::from_buf([x]))
2052 .associated_items(def_id)
2053 .in_definition_order()
2054 .filter(|x| self.is_relevant_kind_for_mode(x.kind))
2061 impl<'tcx> Candidate<'tcx> {
2062 fn to_unadjusted_pick(
2065 unstable_candidates: Vec<(Candidate<'tcx>, Symbol)>,
2069 kind: match self.kind {
2070 InherentImplCandidate(..) => InherentImplPick,
2071 ObjectCandidate => ObjectPick,
2072 TraitCandidate(_) => TraitPick,
2073 WhereClauseCandidate(ref trait_ref) => {
2074 // Only trait derived from where-clauses should
2075 // appear here, so they should not contain any
2076 // inference variables or other artifacts. This
2077 // means they are safe to put into the
2078 // `WhereClausePick`.
2080 !trait_ref.skip_binder().substs.needs_infer()
2081 && !trait_ref.skip_binder().substs.has_placeholders()
2084 WhereClausePick(*trait_ref)
2087 import_ids: self.import_ids.clone(),
2089 autoref_or_ptr_adjustment: None,
2091 unstable_candidates,