1 //! This module is concerned with finding methods that a given type provides.
2 //! For details about how this works in rustc, see the method lookup page in the
3 //! [rustc guide](https://rust-lang.github.io/rustc-guide/method-lookup.html)
4 //! and the corresponding code mostly in librustc_typeck/check/method/probe.rs.
5 use std::{iter, ops::ControlFlow, sync::Arc};
7 use arrayvec::ArrayVec;
8 use base_db::{CrateId, Edition};
9 use chalk_ir::{cast::Cast, Mutability, UniverseIndex};
11 lang_item::LangItemTarget, nameres::DefMap, AssocContainerId, AssocItemId, BlockId, FunctionId,
12 GenericDefId, HasModule, ImplId, Lookup, ModuleId, TraitId,
14 use hir_expand::name::Name;
15 use rustc_hash::{FxHashMap, FxHashSet};
20 consteval::{self, ConstExt},
23 primitive::{self, FloatTy, IntTy, UintTy},
25 utils::all_super_traits,
26 AdtId, Canonical, CanonicalVarKinds, DebruijnIndex, ForeignDefId, InEnvironment, Interner,
27 Scalar, Substitution, TraitEnvironment, TraitRefExt, Ty, TyBuilder, TyExt, TyKind,
30 /// This is used as a key for indexing impls.
31 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
32 pub enum TyFingerprint {
33 // These are lang item impls:
40 // These can have user-defined impls:
43 ForeignType(ForeignDefId),
44 // These only exist for trait impls
51 /// Creates a TyFingerprint for looking up an inherent impl. Only certain
52 /// types can have inherent impls: if we have some `struct S`, we can have
53 /// an `impl S`, but not `impl &S`. Hence, this will return `None` for
54 /// reference types and such.
55 pub fn for_inherent_impl(ty: &Ty) -> Option<TyFingerprint> {
56 let fp = match ty.kind(&Interner) {
57 TyKind::Str => TyFingerprint::Str,
58 TyKind::Never => TyFingerprint::Never,
59 TyKind::Slice(..) => TyFingerprint::Slice,
60 TyKind::Array(..) => TyFingerprint::Array,
61 TyKind::Scalar(scalar) => TyFingerprint::Scalar(*scalar),
62 TyKind::Adt(AdtId(adt), _) => TyFingerprint::Adt(*adt),
63 TyKind::Raw(mutability, ..) => TyFingerprint::RawPtr(*mutability),
64 TyKind::Foreign(alias_id, ..) => TyFingerprint::ForeignType(*alias_id),
65 TyKind::Dyn(_) => ty.dyn_trait().map(TyFingerprint::Dyn)?,
71 /// Creates a TyFingerprint for looking up a trait impl.
72 pub fn for_trait_impl(ty: &Ty) -> Option<TyFingerprint> {
73 let fp = match ty.kind(&Interner) {
74 TyKind::Str => TyFingerprint::Str,
75 TyKind::Never => TyFingerprint::Never,
76 TyKind::Slice(..) => TyFingerprint::Slice,
77 TyKind::Array(..) => TyFingerprint::Array,
78 TyKind::Scalar(scalar) => TyFingerprint::Scalar(*scalar),
79 TyKind::Adt(AdtId(adt), _) => TyFingerprint::Adt(*adt),
80 TyKind::Raw(mutability, ..) => TyFingerprint::RawPtr(*mutability),
81 TyKind::Foreign(alias_id, ..) => TyFingerprint::ForeignType(*alias_id),
82 TyKind::Dyn(_) => ty.dyn_trait().map(TyFingerprint::Dyn)?,
83 TyKind::Ref(_, _, ty) => return TyFingerprint::for_trait_impl(ty),
84 TyKind::Tuple(_, subst) => {
85 let first_ty = subst.interned().get(0).map(|arg| arg.assert_ty_ref(&Interner));
87 Some(ty) => return TyFingerprint::for_trait_impl(ty),
88 None => TyFingerprint::Unit,
91 TyKind::AssociatedType(_, _)
92 | TyKind::OpaqueType(_, _)
94 | TyKind::Closure(_, _)
95 | TyKind::Generator(..)
96 | TyKind::GeneratorWitness(..) => TyFingerprint::Unnameable,
97 TyKind::Function(fn_ptr) => {
98 TyFingerprint::Function(fn_ptr.substitution.0.len(&Interner) as u32)
101 | TyKind::Placeholder(_)
102 | TyKind::BoundVar(_)
103 | TyKind::InferenceVar(_, _)
104 | TyKind::Error => return None,
110 pub(crate) const ALL_INT_FPS: [TyFingerprint; 12] = [
111 TyFingerprint::Scalar(Scalar::Int(IntTy::I8)),
112 TyFingerprint::Scalar(Scalar::Int(IntTy::I16)),
113 TyFingerprint::Scalar(Scalar::Int(IntTy::I32)),
114 TyFingerprint::Scalar(Scalar::Int(IntTy::I64)),
115 TyFingerprint::Scalar(Scalar::Int(IntTy::I128)),
116 TyFingerprint::Scalar(Scalar::Int(IntTy::Isize)),
117 TyFingerprint::Scalar(Scalar::Uint(UintTy::U8)),
118 TyFingerprint::Scalar(Scalar::Uint(UintTy::U16)),
119 TyFingerprint::Scalar(Scalar::Uint(UintTy::U32)),
120 TyFingerprint::Scalar(Scalar::Uint(UintTy::U64)),
121 TyFingerprint::Scalar(Scalar::Uint(UintTy::U128)),
122 TyFingerprint::Scalar(Scalar::Uint(UintTy::Usize)),
125 pub(crate) const ALL_FLOAT_FPS: [TyFingerprint; 2] = [
126 TyFingerprint::Scalar(Scalar::Float(FloatTy::F32)),
127 TyFingerprint::Scalar(Scalar::Float(FloatTy::F64)),
130 /// Trait impls defined or available in some crate.
131 #[derive(Debug, Eq, PartialEq)]
132 pub struct TraitImpls {
133 // If the `Option<TyFingerprint>` is `None`, the impl may apply to any self type.
134 map: FxHashMap<TraitId, FxHashMap<Option<TyFingerprint>, Vec<ImplId>>>,
138 pub(crate) fn trait_impls_in_crate_query(db: &dyn HirDatabase, krate: CrateId) -> Arc<Self> {
139 let _p = profile::span("trait_impls_in_crate_query");
140 let mut impls = Self { map: FxHashMap::default() };
142 let crate_def_map = db.crate_def_map(krate);
143 impls.collect_def_map(db, &crate_def_map);
148 pub(crate) fn trait_impls_in_block_query(
149 db: &dyn HirDatabase,
151 ) -> Option<Arc<Self>> {
152 let _p = profile::span("trait_impls_in_block_query");
153 let mut impls = Self { map: FxHashMap::default() };
155 let block_def_map = db.block_def_map(block)?;
156 impls.collect_def_map(db, &block_def_map);
158 Some(Arc::new(impls))
161 fn collect_def_map(&mut self, db: &dyn HirDatabase, def_map: &DefMap) {
162 for (_module_id, module_data) in def_map.modules() {
163 for impl_id in module_data.scope.impls() {
164 let target_trait = match db.impl_trait(impl_id) {
165 Some(tr) => tr.skip_binders().hir_trait_id(),
168 let self_ty = db.impl_self_ty(impl_id);
169 let self_ty_fp = TyFingerprint::for_trait_impl(self_ty.skip_binders());
178 // To better support custom derives, collect impls in all unnamed const items.
179 // const _: () = { ... };
180 for konst in module_data.scope.unnamed_consts() {
181 let body = db.body(konst.into());
182 for (_, block_def_map) in body.blocks(db.upcast()) {
183 self.collect_def_map(db, &block_def_map);
189 pub(crate) fn trait_impls_in_deps_query(db: &dyn HirDatabase, krate: CrateId) -> Arc<Self> {
190 let _p = profile::span("trait_impls_in_deps_query");
191 let crate_graph = db.crate_graph();
192 let mut res = Self { map: FxHashMap::default() };
194 for krate in crate_graph.transitive_deps(krate) {
195 res.merge(&db.trait_impls_in_crate(krate));
201 fn merge(&mut self, other: &Self) {
202 for (trait_, other_map) in &other.map {
203 let map = self.map.entry(*trait_).or_default();
204 for (fp, impls) in other_map {
205 let vec = map.entry(*fp).or_default();
211 /// Queries all trait impls for the given type.
212 pub fn for_self_ty_without_blanket_impls(
215 ) -> impl Iterator<Item = ImplId> + '_ {
218 .flat_map(move |impls| impls.get(&Some(fp)).into_iter())
219 .flat_map(|it| it.iter().copied())
222 /// Queries all impls of the given trait.
223 pub fn for_trait(&self, trait_: TraitId) -> impl Iterator<Item = ImplId> + '_ {
227 .flat_map(|map| map.values().flat_map(|v| v.iter().copied()))
230 /// Queries all impls of `trait_` that may apply to `self_ty`.
231 pub fn for_trait_and_self_ty(
234 self_ty: TyFingerprint,
235 ) -> impl Iterator<Item = ImplId> + '_ {
239 .flat_map(move |map| map.get(&None).into_iter().chain(map.get(&Some(self_ty))))
240 .flat_map(|v| v.iter().copied())
243 pub fn all_impls(&self) -> impl Iterator<Item = ImplId> + '_ {
244 self.map.values().flat_map(|map| map.values().flat_map(|v| v.iter().copied()))
248 /// Inherent impls defined in some crate.
250 /// Inherent impls can only be defined in the crate that also defines the self type of the impl
251 /// (note that some primitives are considered to be defined by both libcore and liballoc).
253 /// This makes inherent impl lookup easier than trait impl lookup since we only have to consider a
255 #[derive(Debug, Eq, PartialEq)]
256 pub struct InherentImpls {
257 map: FxHashMap<TyFingerprint, Vec<ImplId>>,
261 pub(crate) fn inherent_impls_in_crate_query(db: &dyn HirDatabase, krate: CrateId) -> Arc<Self> {
262 let mut impls = Self { map: FxHashMap::default() };
264 let crate_def_map = db.crate_def_map(krate);
265 impls.collect_def_map(db, &crate_def_map);
267 return Arc::new(impls);
270 pub(crate) fn inherent_impls_in_block_query(
271 db: &dyn HirDatabase,
273 ) -> Option<Arc<Self>> {
274 let mut impls = Self { map: FxHashMap::default() };
275 if let Some(block_def_map) = db.block_def_map(block) {
276 impls.collect_def_map(db, &block_def_map);
277 return Some(Arc::new(impls));
282 fn collect_def_map(&mut self, db: &dyn HirDatabase, def_map: &DefMap) {
283 for (_module_id, module_data) in def_map.modules() {
284 for impl_id in module_data.scope.impls() {
285 let data = db.impl_data(impl_id);
286 if data.target_trait.is_some() {
290 let self_ty = db.impl_self_ty(impl_id);
291 let fp = TyFingerprint::for_inherent_impl(self_ty.skip_binders());
292 if let Some(fp) = fp {
293 self.map.entry(fp).or_default().push(impl_id);
295 // `fp` should only be `None` in error cases (either erroneous code or incomplete name resolution)
298 // To better support custom derives, collect impls in all unnamed const items.
299 // const _: () = { ... };
300 for konst in module_data.scope.unnamed_consts() {
301 let body = db.body(konst.into());
302 for (_, block_def_map) in body.blocks(db.upcast()) {
303 self.collect_def_map(db, &block_def_map);
309 pub fn for_self_ty(&self, self_ty: &Ty) -> &[ImplId] {
310 match TyFingerprint::for_inherent_impl(self_ty) {
311 Some(fp) => self.map.get(&fp).map(|vec| vec.as_ref()).unwrap_or(&[]),
316 pub fn all_impls(&self) -> impl Iterator<Item = ImplId> + '_ {
317 self.map.values().flat_map(|v| v.iter().copied())
322 db: &dyn HirDatabase,
325 ) -> Option<ArrayVec<CrateId, 2>> {
326 // Types like slice can have inherent impls in several crates, (core and alloc).
327 // The corresponding impls are marked with lang items, so we can use them to find the required crates.
328 macro_rules! lang_item_crate {
329 ($($name:expr),+ $(,)?) => {{
330 let mut v = ArrayVec::<LangItemTarget, 2>::new();
332 v.extend(db.lang_item(cur_crate, $name.into()));
338 let mod_to_crate_ids = |module: ModuleId| Some(iter::once(module.krate()).collect());
340 let lang_item_targets = match ty.kind(&Interner) {
341 TyKind::Adt(AdtId(def_id), _) => {
342 return mod_to_crate_ids(def_id.module(db.upcast()));
344 TyKind::Foreign(id) => {
345 return mod_to_crate_ids(
346 from_foreign_def_id(*id).lookup(db.upcast()).module(db.upcast()),
349 TyKind::Scalar(Scalar::Bool) => lang_item_crate!("bool"),
350 TyKind::Scalar(Scalar::Char) => lang_item_crate!("char"),
351 TyKind::Scalar(Scalar::Float(f)) => match f {
352 // There are two lang items: one in libcore (fXX) and one in libstd (fXX_runtime)
353 FloatTy::F32 => lang_item_crate!("f32", "f32_runtime"),
354 FloatTy::F64 => lang_item_crate!("f64", "f64_runtime"),
356 &TyKind::Scalar(Scalar::Int(t)) => {
357 lang_item_crate!(primitive::int_ty_to_string(t))
359 &TyKind::Scalar(Scalar::Uint(t)) => {
360 lang_item_crate!(primitive::uint_ty_to_string(t))
362 TyKind::Str => lang_item_crate!("str_alloc", "str"),
363 TyKind::Slice(_) => lang_item_crate!("slice_alloc", "slice"),
364 TyKind::Array(..) => lang_item_crate!("array"),
365 TyKind::Raw(Mutability::Not, _) => lang_item_crate!("const_ptr"),
366 TyKind::Raw(Mutability::Mut, _) => lang_item_crate!("mut_ptr"),
368 return ty.dyn_trait().and_then(|trait_| {
369 mod_to_crate_ids(GenericDefId::TraitId(trait_).module(db.upcast()))
374 let res = lang_item_targets
376 .filter_map(|it| match it {
377 LangItemTarget::ImplDefId(it) => Some(it),
380 .map(|it| it.lookup(db.upcast()).container.krate())
385 /// Look up the method with the given name, returning the actual autoderefed
386 /// receiver type (but without autoref applied yet).
387 pub(crate) fn lookup_method(
389 db: &dyn HirDatabase,
390 env: Arc<TraitEnvironment>,
392 traits_in_scope: &FxHashSet<TraitId>,
393 visible_from_module: Option<ModuleId>,
395 ) -> Option<(Canonical<Ty>, FunctionId)> {
396 iterate_method_candidates(
404 LookupMode::MethodCall,
406 AssocItemId::FunctionId(f) => Some((ty.clone(), f)),
412 /// Whether we're looking up a dotted method call (like `v.len()`) or a path
413 /// (like `Vec::new`).
414 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
415 pub enum LookupMode {
416 /// Looking up a method call like `v.len()`: We only consider candidates
417 /// that have a `self` parameter, and do autoderef.
419 /// Looking up a path like `Vec::new` or `Vec::default`: We consider all
420 /// candidates including associated constants, but don't do autoderef.
424 // This would be nicer if it just returned an iterator, but that runs into
425 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
426 // FIXME add a context type here?
427 pub fn iterate_method_candidates<T>(
429 db: &dyn HirDatabase,
430 env: Arc<TraitEnvironment>,
432 traits_in_scope: &FxHashSet<TraitId>,
433 visible_from_module: Option<ModuleId>,
436 mut callback: impl FnMut(&Canonical<Ty>, AssocItemId) -> Option<T>,
439 iterate_method_candidates_dyn(
449 assert!(slot.is_none());
450 if let Some(it) = callback(ty, item) {
452 return ControlFlow::Break(());
454 ControlFlow::Continue(())
460 pub fn iterate_method_candidates_dyn(
462 db: &dyn HirDatabase,
463 env: Arc<TraitEnvironment>,
465 traits_in_scope: &FxHashSet<TraitId>,
466 visible_from_module: Option<ModuleId>,
469 callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
470 ) -> ControlFlow<()> {
472 LookupMode::MethodCall => {
473 // For method calls, rust first does any number of autoderef, and then one
474 // autoref (i.e. when the method takes &self or &mut self). We just ignore
475 // the autoref currently -- when we find a method matching the given name,
476 // we assume it fits.
478 // Also note that when we've got a receiver like &S, even if the method we
479 // find in the end takes &self, we still do the autoderef step (just as
480 // rustc does an autoderef and then autoref again).
481 let ty = InEnvironment { goal: ty.clone(), environment: env.env.clone() };
483 // We have to be careful about the order we're looking at candidates
484 // in here. Consider the case where we're resolving `x.clone()`
485 // where `x: &Vec<_>`. This resolves to the clone method with self
486 // type `Vec<_>`, *not* `&_`. I.e. we need to consider methods where
487 // the receiver type exactly matches before cases where we have to
488 // do autoref. But in the autoderef steps, the `&_` self type comes
489 // up *before* the `Vec<_>` self type.
491 // On the other hand, we don't want to just pick any by-value method
492 // before any by-autoref method; it's just that we need to consider
493 // the methods by autoderef order of *receiver types*, not *self
496 let deref_chain = autoderef_method_receiver(db, krate, ty);
497 for i in 0..deref_chain.len() {
498 iterate_method_candidates_with_autoref(
509 ControlFlow::Continue(())
511 LookupMode::Path => {
512 // No autoderef for path lookups
513 iterate_method_candidates_for_self_ty(
527 fn iterate_method_candidates_with_autoref(
528 deref_chain: &[Canonical<Ty>],
529 db: &dyn HirDatabase,
530 env: Arc<TraitEnvironment>,
532 traits_in_scope: &FxHashSet<TraitId>,
533 visible_from_module: Option<ModuleId>,
535 mut callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
536 ) -> ControlFlow<()> {
537 let (receiver_ty, rest) = match deref_chain.split_first() {
538 Some((rec, rest)) => (rec.clone(), rest),
540 never!("received empty deref-chain");
541 return ControlFlow::Break(());
544 iterate_method_candidates_by_receiver(
556 let refed = Canonical {
557 binders: receiver_ty.binders.clone(),
558 value: TyKind::Ref(Mutability::Not, static_lifetime(), receiver_ty.value.clone())
562 iterate_method_candidates_by_receiver(
574 let ref_muted = Canonical {
575 binders: receiver_ty.binders,
576 value: TyKind::Ref(Mutability::Mut, static_lifetime(), receiver_ty.value).intern(&Interner),
579 iterate_method_candidates_by_receiver(
592 fn iterate_method_candidates_by_receiver(
593 receiver_ty: &Canonical<Ty>,
594 rest_of_deref_chain: &[Canonical<Ty>],
595 db: &dyn HirDatabase,
596 env: Arc<TraitEnvironment>,
598 traits_in_scope: &FxHashSet<TraitId>,
599 visible_from_module: Option<ModuleId>,
601 mut callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
602 ) -> ControlFlow<()> {
603 // We're looking for methods with *receiver* type receiver_ty. These could
604 // be found in any of the derefs of receiver_ty, so we have to go through
606 for self_ty in iter::once(receiver_ty).chain(rest_of_deref_chain) {
607 iterate_inherent_methods(
619 for self_ty in iter::once(receiver_ty).chain(rest_of_deref_chain) {
620 iterate_trait_method_candidates(
632 ControlFlow::Continue(())
635 fn iterate_method_candidates_for_self_ty(
636 self_ty: &Canonical<Ty>,
637 db: &dyn HirDatabase,
638 env: Arc<TraitEnvironment>,
640 traits_in_scope: &FxHashSet<TraitId>,
641 visible_from_module: Option<ModuleId>,
643 mut callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
644 ) -> ControlFlow<()> {
645 iterate_inherent_methods(
655 iterate_trait_method_candidates(self_ty, db, env, krate, traits_in_scope, name, None, callback)
658 fn iterate_trait_method_candidates(
659 self_ty: &Canonical<Ty>,
660 db: &dyn HirDatabase,
661 env: Arc<TraitEnvironment>,
663 traits_in_scope: &FxHashSet<TraitId>,
665 receiver_ty: Option<&Canonical<Ty>>,
666 callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
667 ) -> ControlFlow<()> {
668 let receiver_is_array = matches!(self_ty.value.kind(&Interner), chalk_ir::TyKind::Array(..));
669 // if ty is `dyn Trait`, the trait doesn't need to be in scope
671 self_ty.value.dyn_trait().into_iter().flat_map(|t| all_super_traits(db.upcast(), t));
672 let env_traits = match self_ty.value.kind(&Interner) {
673 TyKind::Placeholder(_) => {
674 // if we have `T: Trait` in the param env, the trait doesn't need to be in scope
675 env.traits_in_scope_from_clauses(&self_ty.value)
676 .flat_map(|t| all_super_traits(db.upcast(), t))
681 let traits = inherent_trait.chain(env_traits).chain(traits_in_scope.iter().copied());
683 'traits: for t in traits {
684 let data = db.trait_data(t);
686 // Traits annotated with `#[rustc_skip_array_during_method_dispatch]` are skipped during
687 // method resolution, if the receiver is an array, and we're compiling for editions before
689 // This is to make `[a].into_iter()` not break code with the new `IntoIterator` impl for
691 if data.skip_array_during_method_dispatch && receiver_is_array {
692 // FIXME: this should really be using the edition of the method name's span, in case it
693 // comes from a macro
694 if db.crate_graph()[krate].edition < Edition::Edition2021 {
699 // we'll be lazy about checking whether the type implements the
700 // trait, but if we find out it doesn't, we'll skip the rest of the
702 let mut known_implemented = false;
703 for (_name, item) in data.items.iter() {
704 // Don't pass a `visible_from_module` down to `is_valid_candidate`,
705 // since only inherent methods should be included into visibility checking.
706 if !is_valid_candidate(db, env.clone(), name, receiver_ty, *item, self_ty, None) {
709 if !known_implemented {
710 let goal = generic_implements_goal(db, env.clone(), t, self_ty.clone());
711 if db.trait_solve(krate, goal.cast(&Interner)).is_none() {
715 known_implemented = true;
716 // FIXME: we shouldn't be ignoring the binders here
717 callback(self_ty, *item)?
720 ControlFlow::Continue(())
723 fn filter_inherent_impls_for_self_ty<'i>(
724 impls: &'i InherentImpls,
726 ) -> impl Iterator<Item = &'i ImplId> {
727 // inherent methods on arrays are fingerprinted as [T; {unknown}], so we must also consider them when
728 // resolving a method call on an array with a known len
730 if let TyKind::Array(parameters, array_len) = self_ty.kind(&Interner) {
731 if !array_len.is_unknown() {
732 let unknown_array_len_ty =
733 TyKind::Array(parameters.clone(), consteval::usize_const(None))
736 Some(impls.for_self_ty(&unknown_array_len_ty))
747 impls.for_self_ty(self_ty).iter().chain(array_impls)
750 fn iterate_inherent_methods(
751 self_ty: &Canonical<Ty>,
752 db: &dyn HirDatabase,
753 env: Arc<TraitEnvironment>,
755 receiver_ty: Option<&Canonical<Ty>>,
757 visible_from_module: Option<ModuleId>,
758 callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
759 ) -> ControlFlow<()> {
760 let def_crates = match def_crates(db, &self_ty.value, krate) {
762 None => return ControlFlow::Continue(()),
765 if let Some(module_id) = visible_from_module {
766 if let Some(block_id) = module_id.containing_block() {
767 if let Some(impls) = db.inherent_impls_in_block(block_id) {
782 for krate in def_crates {
783 let impls = db.inherent_impls_in_crate(krate);
795 return ControlFlow::Continue(());
797 fn impls_for_self_ty(
798 impls: &InherentImpls,
799 self_ty: &Canonical<Ty>,
800 db: &dyn HirDatabase,
801 env: Arc<TraitEnvironment>,
803 receiver_ty: Option<&Canonical<Ty>>,
804 visible_from_module: Option<ModuleId>,
805 callback: &mut dyn FnMut(&Canonical<Ty>, AssocItemId) -> ControlFlow<()>,
806 ) -> ControlFlow<()> {
807 let impls_for_self_ty = filter_inherent_impls_for_self_ty(impls, &self_ty.value);
808 for &impl_def in impls_for_self_ty {
809 for &item in &db.impl_data(impl_def).items {
810 if !is_valid_candidate(
821 // we have to check whether the self type unifies with the type
822 // that the impl is for. If we have a receiver type, this
823 // already happens in `is_valid_candidate` above; if not, we
825 if receiver_ty.is_none()
826 && inherent_impl_substs(db, env.clone(), impl_def, self_ty).is_none()
828 cov_mark::hit!(impl_self_type_match_without_receiver);
831 let receiver_ty = receiver_ty.unwrap_or(self_ty);
832 callback(receiver_ty, item)?;
835 ControlFlow::Continue(())
839 /// Returns the self type for the index trait call.
840 pub fn resolve_indexing_op(
841 db: &dyn HirDatabase,
843 env: Arc<TraitEnvironment>,
845 index_trait: TraitId,
846 ) -> Option<Canonical<Ty>> {
847 let ty = InEnvironment { goal: ty.clone(), environment: env.env.clone() };
848 let deref_chain = autoderef_method_receiver(db, krate, ty);
849 for ty in deref_chain {
850 let goal = generic_implements_goal(db, env.clone(), index_trait, ty.clone());
851 if db.trait_solve(krate, goal.cast(&Interner)).is_some() {
858 fn is_transformed_receiver_ty_equal(transformed_receiver_ty: &Ty, receiver_ty: &Ty) -> bool {
859 if transformed_receiver_ty == receiver_ty {
863 // a transformed receiver may be considered equal (and a valid method call candidate) if it is an array
864 // with an unknown (i.e. generic) length, and the receiver is an array with the same item type but a known len,
865 // this allows inherent methods on arrays to be considered valid resolution candidates
866 match (transformed_receiver_ty.kind(&Interner), receiver_ty.kind(&Interner)) {
868 TyKind::Array(transformed_array_ty, transformed_array_len),
869 TyKind::Array(receiver_array_ty, receiver_array_len),
870 ) if transformed_array_ty == receiver_array_ty
871 && transformed_array_len.is_unknown()
872 && !receiver_array_len.is_unknown() =>
880 fn is_valid_candidate(
881 db: &dyn HirDatabase,
882 env: Arc<TraitEnvironment>,
884 receiver_ty: Option<&Canonical<Ty>>,
886 self_ty: &Canonical<Ty>,
887 visible_from_module: Option<ModuleId>,
890 AssocItemId::FunctionId(m) => {
891 let data = db.function_data(m);
892 if let Some(name) = name {
893 if &data.name != name {
897 if let Some(receiver_ty) = receiver_ty {
898 if !data.has_self_param() {
901 let transformed_receiver_ty = match transform_receiver_ty(db, env, m, self_ty) {
903 None => return false,
906 if !is_transformed_receiver_ty_equal(&transformed_receiver_ty, &receiver_ty.value) {
910 if let Some(from_module) = visible_from_module {
911 if !db.function_visibility(m).is_visible_from(db.upcast(), from_module) {
912 cov_mark::hit!(autoderef_candidate_not_visible);
919 AssocItemId::ConstId(c) => {
920 let data = db.const_data(c);
921 name.map_or(true, |name| data.name.as_ref() == Some(name)) && receiver_ty.is_none()
927 pub(crate) fn inherent_impl_substs(
928 db: &dyn HirDatabase,
929 env: Arc<TraitEnvironment>,
931 self_ty: &Canonical<Ty>,
932 ) -> Option<Substitution> {
933 // we create a var for each type parameter of the impl; we need to keep in
934 // mind here that `self_ty` might have vars of its own
935 let self_ty_vars = self_ty.binders.len(&Interner);
936 let vars = TyBuilder::subst_for_def(db, impl_id)
937 .fill_with_bound_vars(DebruijnIndex::INNERMOST, self_ty_vars)
939 let self_ty_with_vars = db.impl_self_ty(impl_id).substitute(&Interner, &vars);
940 let mut kinds = self_ty.binders.interned().to_vec();
942 iter::repeat(chalk_ir::WithKind::new(
943 chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General),
946 .take(vars.len(&Interner)),
948 let tys = Canonical {
949 binders: CanonicalVarKinds::from_iter(&Interner, kinds),
950 value: (self_ty_with_vars, self_ty.value.clone()),
952 let substs = super::infer::unify(db, env, &tys)?;
953 // We only want the substs for the vars we added, not the ones from self_ty.
954 // Also, if any of the vars we added are still in there, we replace them by
955 // Unknown. I think this can only really happen if self_ty contained
956 // Unknown, and in that case we want the result to contain Unknown in those
959 Substitution::from_iter(&Interner, substs.iter(&Interner).cloned().skip(self_ty_vars));
960 Some(fallback_bound_vars(suffix, self_ty_vars))
963 /// This replaces any 'free' Bound vars in `s` (i.e. those with indices past
964 /// num_vars_to_keep) by `TyKind::Unknown`.
965 fn fallback_bound_vars(s: Substitution, num_vars_to_keep: usize) -> Substitution {
966 crate::fold_free_vars(s, |bound, binders| {
967 if bound.index >= num_vars_to_keep && bound.debruijn == DebruijnIndex::INNERMOST {
968 TyKind::Error.intern(&Interner)
970 bound.shifted_in_from(binders).to_ty(&Interner)
975 fn transform_receiver_ty(
976 db: &dyn HirDatabase,
977 env: Arc<TraitEnvironment>,
978 function_id: FunctionId,
979 self_ty: &Canonical<Ty>,
981 let substs = match function_id.lookup(db.upcast()).container {
982 AssocContainerId::TraitId(_) => TyBuilder::subst_for_def(db, function_id)
983 .push(self_ty.value.clone())
986 AssocContainerId::ImplId(impl_id) => {
987 let impl_substs = inherent_impl_substs(db, env, impl_id, self_ty)?;
988 TyBuilder::subst_for_def(db, function_id)
989 .use_parent_substs(&impl_substs)
993 AssocContainerId::ModuleId(_) => unreachable!(),
995 let sig = db.callable_item_signature(function_id.into());
996 Some(sig.map(|s| s.params()[0].clone()).substitute(&Interner, &substs))
999 pub fn implements_trait(
1001 db: &dyn HirDatabase,
1002 env: Arc<TraitEnvironment>,
1006 let goal = generic_implements_goal(db, env, trait_, ty.clone());
1007 let solution = db.trait_solve(krate, goal.cast(&Interner));
1012 pub fn implements_trait_unique(
1014 db: &dyn HirDatabase,
1015 env: Arc<TraitEnvironment>,
1019 let goal = generic_implements_goal(db, env, trait_, ty.clone());
1020 let solution = db.trait_solve(krate, goal.cast(&Interner));
1022 matches!(solution, Some(crate::Solution::Unique(_)))
1025 /// This creates Substs for a trait with the given Self type and type variables
1026 /// for all other parameters, to query Chalk with it.
1027 fn generic_implements_goal(
1028 db: &dyn HirDatabase,
1029 env: Arc<TraitEnvironment>,
1031 self_ty: Canonical<Ty>,
1032 ) -> Canonical<InEnvironment<super::DomainGoal>> {
1033 let mut kinds = self_ty.binders.interned().to_vec();
1034 let trait_ref = TyBuilder::trait_ref(db, trait_)
1035 .push(self_ty.value)
1036 .fill_with_bound_vars(DebruijnIndex::INNERMOST, kinds.len())
1039 iter::repeat(chalk_ir::WithKind::new(
1040 chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General),
1041 UniverseIndex::ROOT,
1043 .take(trait_ref.substitution.len(&Interner) - 1),
1045 let obligation = trait_ref.cast(&Interner);
1047 binders: CanonicalVarKinds::from_iter(&Interner, kinds),
1048 value: InEnvironment::new(&env.env, obligation),
1052 fn autoderef_method_receiver(
1053 db: &dyn HirDatabase,
1055 ty: InEnvironment<Canonical<Ty>>,
1056 ) -> Vec<Canonical<Ty>> {
1057 let mut deref_chain: Vec<_> = autoderef::autoderef(db, Some(krate), ty).collect();
1058 // As a last step, we can do array unsizing (that's the only unsizing that rustc does for method receivers!)
1059 if let Some(TyKind::Array(parameters, _)) =
1060 deref_chain.last().map(|ty| ty.value.kind(&Interner))
1062 let kinds = deref_chain.last().unwrap().binders.clone();
1063 let unsized_ty = TyKind::Slice(parameters.clone()).intern(&Interner);
1064 deref_chain.push(Canonical { value: unsized_ty, binders: kinds })