crates/hir_ty/src/method_resolution.rs

   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, sync::Arc};
   6
   7 use arrayvec::ArrayVec;
   8 use base_db::CrateId;
   9 use chalk_ir::{cast::Cast, Mutability, UniverseIndex};
  10 use hir_def::{
  11     lang_item::LangItemTarget, nameres::DefMap, AssocContainerId, AssocItemId, FunctionId,
  12     GenericDefId, HasModule, ImplId, Lookup, ModuleId, TraitId,
  13 };
  14 use hir_expand::name::Name;
  15 use rustc_hash::{FxHashMap, FxHashSet};
  16
  17 use crate::{
  18     autoderef,
  19     db::HirDatabase,
  20     from_foreign_def_id,
  21     primitive::{self, FloatTy, IntTy, UintTy},
  22     static_lifetime,
  23     utils::all_super_traits,
  24     AdtId, Canonical, CanonicalVarKinds, DebruijnIndex, ForeignDefId, InEnvironment, Interner,
  25     Scalar, Substitution, TraitEnvironment, TraitRefExt, Ty, TyBuilder, TyExt, TyKind,
  26 };
  27
  28 /// This is used as a key for indexing impls.
  29 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
  30 pub enum TyFingerprint {
  31     // These are lang item impls:
  32     Str,
  33     Slice,
  34     Array,
  35     Never,
  36     RawPtr(Mutability),
  37     Scalar(Scalar),
  38     // These can have user-defined impls:
  39     Adt(hir_def::AdtId),
  40     Dyn(TraitId),
  41     ForeignType(ForeignDefId),
  42     // These only exist for trait impls
  43     Unit,
  44     Unnameable,
  45     Function(u32),
  46 }
  47
  48 impl TyFingerprint {
  49     /// Creates a TyFingerprint for looking up an inherent impl. Only certain
  50     /// types can have inherent impls: if we have some `struct S`, we can have
  51     /// an `impl S`, but not `impl &S`. Hence, this will return `None` for
  52     /// reference types and such.
  53     pub fn for_inherent_impl(ty: &Ty) -> Option<TyFingerprint> {
  54         let fp = match ty.kind(&Interner) {
  55             TyKind::Str => TyFingerprint::Str,
  56             TyKind::Never => TyFingerprint::Never,
  57             TyKind::Slice(..) => TyFingerprint::Slice,
  58             TyKind::Array(..) => TyFingerprint::Array,
  59             TyKind::Scalar(scalar) => TyFingerprint::Scalar(*scalar),
  60             TyKind::Adt(AdtId(adt), _) => TyFingerprint::Adt(*adt),
  61             TyKind::Raw(mutability, ..) => TyFingerprint::RawPtr(*mutability),
  62             TyKind::Foreign(alias_id, ..) => TyFingerprint::ForeignType(*alias_id),
  63             TyKind::Dyn(_) => ty.dyn_trait().map(|trait_| TyFingerprint::Dyn(trait_))?,
  64             _ => return None,
  65         };
  66         Some(fp)
  67     }
  68
  69     /// Creates a TyFingerprint for looking up a trait impl.
  70     pub fn for_trait_impl(ty: &Ty) -> Option<TyFingerprint> {
  71         let fp = match ty.kind(&Interner) {
  72             TyKind::Str => TyFingerprint::Str,
  73             TyKind::Never => TyFingerprint::Never,
  74             TyKind::Slice(..) => TyFingerprint::Slice,
  75             TyKind::Array(..) => TyFingerprint::Array,
  76             TyKind::Scalar(scalar) => TyFingerprint::Scalar(*scalar),
  77             TyKind::Adt(AdtId(adt), _) => TyFingerprint::Adt(*adt),
  78             TyKind::Raw(mutability, ..) => TyFingerprint::RawPtr(*mutability),
  79             TyKind::Foreign(alias_id, ..) => TyFingerprint::ForeignType(*alias_id),
  80             TyKind::Dyn(_) => ty.dyn_trait().map(|trait_| TyFingerprint::Dyn(trait_))?,
  81             TyKind::Ref(_, _, ty) => return TyFingerprint::for_trait_impl(ty),
  82             TyKind::Tuple(_, subst) => {
  83                 let first_ty = subst.interned().get(0).map(|arg| arg.assert_ty_ref(&Interner));
  84                 if let Some(ty) = first_ty {
  85                     return TyFingerprint::for_trait_impl(ty);
  86                 } else {
  87                     TyFingerprint::Unit
  88                 }
  89             }
  90             TyKind::AssociatedType(_, _)
  91             | TyKind::OpaqueType(_, _)
  92             | TyKind::FnDef(_, _)
  93             | TyKind::Closure(_, _)
  94             | TyKind::Generator(..)
  95             | TyKind::GeneratorWitness(..) => TyFingerprint::Unnameable,
  96             TyKind::Function(fn_ptr) => {
  97                 TyFingerprint::Function(fn_ptr.substitution.0.len(&Interner) as u32)
  98             }
  99             TyKind::Alias(_)
 100             | TyKind::Placeholder(_)
 101             | TyKind::BoundVar(_)
 102             | TyKind::InferenceVar(_, _)
 103             | TyKind::Error => return None,
 104         };
 105         Some(fp)
 106     }
 107 }
 108
 109 pub(crate) const ALL_INT_FPS: [TyFingerprint; 12] = [
 110     TyFingerprint::Scalar(Scalar::Int(IntTy::I8)),
 111     TyFingerprint::Scalar(Scalar::Int(IntTy::I16)),
 112     TyFingerprint::Scalar(Scalar::Int(IntTy::I32)),
 113     TyFingerprint::Scalar(Scalar::Int(IntTy::I64)),
 114     TyFingerprint::Scalar(Scalar::Int(IntTy::I128)),
 115     TyFingerprint::Scalar(Scalar::Int(IntTy::Isize)),
 116     TyFingerprint::Scalar(Scalar::Uint(UintTy::U8)),
 117     TyFingerprint::Scalar(Scalar::Uint(UintTy::U16)),
 118     TyFingerprint::Scalar(Scalar::Uint(UintTy::U32)),
 119     TyFingerprint::Scalar(Scalar::Uint(UintTy::U64)),
 120     TyFingerprint::Scalar(Scalar::Uint(UintTy::U128)),
 121     TyFingerprint::Scalar(Scalar::Uint(UintTy::Usize)),
 122 ];
 123
 124 pub(crate) const ALL_FLOAT_FPS: [TyFingerprint; 2] = [
 125     TyFingerprint::Scalar(Scalar::Float(FloatTy::F32)),
 126     TyFingerprint::Scalar(Scalar::Float(FloatTy::F64)),
 127 ];
 128
 129 /// Trait impls defined or available in some crate.
 130 #[derive(Debug, Eq, PartialEq)]
 131 pub struct TraitImpls {
 132     // If the `Option<TyFingerprint>` is `None`, the impl may apply to any self type.
 133     map: FxHashMap<TraitId, FxHashMap<Option<TyFingerprint>, Vec<ImplId>>>,
 134 }
 135
 136 impl TraitImpls {
 137     pub(crate) fn trait_impls_in_crate_query(db: &dyn HirDatabase, krate: CrateId) -> Arc<Self> {
 138         let _p = profile::span("trait_impls_in_crate_query");
 139         let mut impls = Self { map: FxHashMap::default() };
 140
 141         let crate_def_map = db.crate_def_map(krate);
 142         collect_def_map(db, &crate_def_map, &mut impls);
 143
 144         return Arc::new(impls);
 145
 146         fn collect_def_map(db: &dyn HirDatabase, def_map: &DefMap, impls: &mut TraitImpls) {
 147             for (_module_id, module_data) in def_map.modules() {
 148                 for impl_id in module_data.scope.impls() {
 149                     let target_trait = match db.impl_trait(impl_id) {
 150                         Some(tr) => tr.skip_binders().hir_trait_id(),
 151                         None => continue,
 152                     };
 153                     let self_ty = db.impl_self_ty(impl_id);
 154                     let self_ty_fp = TyFingerprint::for_trait_impl(self_ty.skip_binders());
 155                     impls
 156                         .map
 157                         .entry(target_trait)
 158                         .or_default()
 159                         .entry(self_ty_fp)
 160                         .or_default()
 161                         .push(impl_id);
 162                 }
 163
 164                 // To better support custom derives, collect impls in all unnamed const items.
 165                 // const _: () = { ... };
 166                 for konst in module_data.scope.unnamed_consts() {
 167                     let body = db.body(konst.into());
 168                     for (_, block_def_map) in body.blocks(db.upcast()) {
 169                         collect_def_map(db, &block_def_map, impls);
 170                     }
 171                 }
 172             }
 173         }
 174     }
 175
 176     pub(crate) fn trait_impls_in_deps_query(db: &dyn HirDatabase, krate: CrateId) -> Arc<Self> {
 177         let _p = profile::span("trait_impls_in_deps_query");
 178         let crate_graph = db.crate_graph();
 179         let mut res = Self { map: FxHashMap::default() };
 180
 181         for krate in crate_graph.transitive_deps(krate) {
 182             res.merge(&db.trait_impls_in_crate(krate));
 183         }
 184
 185         Arc::new(res)
 186     }
 187
 188     fn merge(&mut self, other: &Self) {
 189         for (trait_, other_map) in &other.map {
 190             let map = self.map.entry(*trait_).or_default();
 191             for (fp, impls) in other_map {
 192                 let vec = map.entry(*fp).or_default();
 193                 vec.extend(impls);
 194             }
 195         }
 196     }
 197
 198     /// Queries all trait impls for the given type.
 199     pub fn for_self_ty_without_blanket_impls(
 200         &self,
 201         fp: TyFingerprint,
 202     ) -> impl Iterator<Item = ImplId> + '_ {
 203         self.map
 204             .values()
 205             .flat_map(move |impls| impls.get(&Some(fp)).into_iter())
 206             .flat_map(|it| it.iter().copied())
 207     }
 208
 209     /// Queries all impls of the given trait.
 210     pub fn for_trait(&self, trait_: TraitId) -> impl Iterator<Item = ImplId> + '_ {
 211         self.map
 212             .get(&trait_)
 213             .into_iter()
 214             .flat_map(|map| map.values().flat_map(|v| v.iter().copied()))
 215     }
 216
 217     /// Queries all impls of `trait_` that may apply to `self_ty`.
 218     pub fn for_trait_and_self_ty(
 219         &self,
 220         trait_: TraitId,
 221         self_ty: TyFingerprint,
 222     ) -> impl Iterator<Item = ImplId> + '_ {
 223         self.map
 224             .get(&trait_)
 225             .into_iter()
 226             .flat_map(move |map| map.get(&None).into_iter().chain(map.get(&Some(self_ty))))
 227             .flat_map(|v| v.iter().copied())
 228     }
 229
 230     pub fn all_impls(&self) -> impl Iterator<Item = ImplId> + '_ {
 231         self.map.values().flat_map(|map| map.values().flat_map(|v| v.iter().copied()))
 232     }
 233 }
 234
 235 /// Inherent impls defined in some crate.
 236 ///
 237 /// Inherent impls can only be defined in the crate that also defines the self type of the impl
 238 /// (note that some primitives are considered to be defined by both libcore and liballoc).
 239 ///
 240 /// This makes inherent impl lookup easier than trait impl lookup since we only have to consider a
 241 /// single crate.
 242 #[derive(Debug, Eq, PartialEq)]
 243 pub struct InherentImpls {
 244     map: FxHashMap<TyFingerprint, Vec<ImplId>>,
 245 }
 246
 247 impl InherentImpls {
 248     pub(crate) fn inherent_impls_in_crate_query(db: &dyn HirDatabase, krate: CrateId) -> Arc<Self> {
 249         let mut impls = Self { map: FxHashMap::default() };
 250
 251         let crate_def_map = db.crate_def_map(krate);
 252         collect_def_map(db, &crate_def_map, &mut impls);
 253
 254         return Arc::new(impls);
 255
 256         fn collect_def_map(db: &dyn HirDatabase, def_map: &DefMap, impls: &mut InherentImpls) {
 257             for (_module_id, module_data) in def_map.modules() {
 258                 for impl_id in module_data.scope.impls() {
 259                     let data = db.impl_data(impl_id);
 260                     if data.target_trait.is_some() {
 261                         continue;
 262                     }
 263
 264                     let self_ty = db.impl_self_ty(impl_id);
 265                     let fp = TyFingerprint::for_inherent_impl(self_ty.skip_binders());
 266                     if let Some(fp) = fp {
 267                         impls.map.entry(fp).or_default().push(impl_id);
 268                     }
 269                     // `fp` should only be `None` in error cases (either erroneous code or incomplete name resolution)
 270                 }
 271
 272                 // To better support custom derives, collect impls in all unnamed const items.
 273                 // const _: () = { ... };
 274                 for konst in module_data.scope.unnamed_consts() {
 275                     let body = db.body(konst.into());
 276                     for (_, block_def_map) in body.blocks(db.upcast()) {
 277                         collect_def_map(db, &block_def_map, impls);
 278                     }
 279                 }
 280             }
 281         }
 282     }
 283
 284     pub fn for_self_ty(&self, self_ty: &Ty) -> &[ImplId] {
 285         match TyFingerprint::for_inherent_impl(self_ty) {
 286             Some(fp) => self.map.get(&fp).map(|vec| vec.as_ref()).unwrap_or(&[]),
 287             None => &[],
 288         }
 289     }
 290
 291     pub fn all_impls(&self) -> impl Iterator<Item = ImplId> + '_ {
 292         self.map.values().flat_map(|v| v.iter().copied())
 293     }
 294 }
 295
 296 pub fn def_crates(
 297     db: &dyn HirDatabase,
 298     ty: &Ty,
 299     cur_crate: CrateId,
 300 ) -> Option<ArrayVec<CrateId, 2>> {
 301     // Types like slice can have inherent impls in several crates, (core and alloc).
 302     // The corresponding impls are marked with lang items, so we can use them to find the required crates.
 303     macro_rules! lang_item_crate {
 304             ($($name:expr),+ $(,)?) => {{
 305                 let mut v = ArrayVec::<LangItemTarget, 2>::new();
 306                 $(
 307                     v.extend(db.lang_item(cur_crate, $name.into()));
 308                 )+
 309                 v
 310             }};
 311         }
 312
 313     let mod_to_crate_ids = |module: ModuleId| Some(std::iter::once(module.krate()).collect());
 314
 315     let lang_item_targets = match ty.kind(&Interner) {
 316         TyKind::Adt(AdtId(def_id), _) => {
 317             return mod_to_crate_ids(def_id.module(db.upcast()));
 318         }
 319         TyKind::Foreign(id) => {
 320             return mod_to_crate_ids(
 321                 from_foreign_def_id(*id).lookup(db.upcast()).module(db.upcast()),
 322             );
 323         }
 324         TyKind::Scalar(Scalar::Bool) => lang_item_crate!("bool"),
 325         TyKind::Scalar(Scalar::Char) => lang_item_crate!("char"),
 326         TyKind::Scalar(Scalar::Float(f)) => match f {
 327             // There are two lang items: one in libcore (fXX) and one in libstd (fXX_runtime)
 328             FloatTy::F32 => lang_item_crate!("f32", "f32_runtime"),
 329             FloatTy::F64 => lang_item_crate!("f64", "f64_runtime"),
 330         },
 331         &TyKind::Scalar(Scalar::Int(t)) => {
 332             lang_item_crate!(primitive::int_ty_to_string(t))
 333         }
 334         &TyKind::Scalar(Scalar::Uint(t)) => {
 335             lang_item_crate!(primitive::uint_ty_to_string(t))
 336         }
 337         TyKind::Str => lang_item_crate!("str_alloc", "str"),
 338         TyKind::Slice(_) => lang_item_crate!("slice_alloc", "slice"),
 339         TyKind::Raw(Mutability::Not, _) => lang_item_crate!("const_ptr"),
 340         TyKind::Raw(Mutability::Mut, _) => lang_item_crate!("mut_ptr"),
 341         TyKind::Dyn(_) => {
 342             return ty.dyn_trait().and_then(|trait_| {
 343                 mod_to_crate_ids(GenericDefId::TraitId(trait_).module(db.upcast()))
 344             });
 345         }
 346         _ => return None,
 347     };
 348     let res = lang_item_targets
 349         .into_iter()
 350         .filter_map(|it| match it {
 351             LangItemTarget::ImplDefId(it) => Some(it),
 352             _ => None,
 353         })
 354         .map(|it| it.lookup(db.upcast()).container.krate())
 355         .collect();
 356     Some(res)
 357 }
 358
 359 /// Look up the method with the given name, returning the actual autoderefed
 360 /// receiver type (but without autoref applied yet).
 361 pub(crate) fn lookup_method(
 362     ty: &Canonical<Ty>,
 363     db: &dyn HirDatabase,
 364     env: Arc<TraitEnvironment>,
 365     krate: CrateId,
 366     traits_in_scope: &FxHashSet<TraitId>,
 367     visible_from_module: Option<ModuleId>,
 368     name: &Name,
 369 ) -> Option<(Ty, FunctionId)> {
 370     iterate_method_candidates(
 371         ty,
 372         db,
 373         env,
 374         krate,
 375         &traits_in_scope,
 376         visible_from_module,
 377         Some(name),
 378         LookupMode::MethodCall,
 379         |ty, f| match f {
 380             AssocItemId::FunctionId(f) => Some((ty.clone(), f)),
 381             _ => None,
 382         },
 383     )
 384 }
 385
 386 /// Whether we're looking up a dotted method call (like `v.len()`) or a path
 387 /// (like `Vec::new`).
 388 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 389 pub enum LookupMode {
 390     /// Looking up a method call like `v.len()`: We only consider candidates
 391     /// that have a `self` parameter, and do autoderef.
 392     MethodCall,
 393     /// Looking up a path like `Vec::new` or `Vec::default`: We consider all
 394     /// candidates including associated constants, but don't do autoderef.
 395     Path,
 396 }
 397
 398 // This would be nicer if it just returned an iterator, but that runs into
 399 // lifetime problems, because we need to borrow temp `CrateImplDefs`.
 400 // FIXME add a context type here?
 401 pub fn iterate_method_candidates<T>(
 402     ty: &Canonical<Ty>,
 403     db: &dyn HirDatabase,
 404     env: Arc<TraitEnvironment>,
 405     krate: CrateId,
 406     traits_in_scope: &FxHashSet<TraitId>,
 407     visible_from_module: Option<ModuleId>,
 408     name: Option<&Name>,
 409     mode: LookupMode,
 410     mut callback: impl FnMut(&Ty, AssocItemId) -> Option<T>,
 411 ) -> Option<T> {
 412     let mut slot = None;
 413     iterate_method_candidates_impl(
 414         ty,
 415         db,
 416         env,
 417         krate,
 418         traits_in_scope,
 419         visible_from_module,
 420         name,
 421         mode,
 422         &mut |ty, item| {
 423             assert!(slot.is_none());
 424             slot = callback(ty, item);
 425             slot.is_some()
 426         },
 427     );
 428     slot
 429 }
 430
 431 fn iterate_method_candidates_impl(
 432     ty: &Canonical<Ty>,
 433     db: &dyn HirDatabase,
 434     env: Arc<TraitEnvironment>,
 435     krate: CrateId,
 436     traits_in_scope: &FxHashSet<TraitId>,
 437     visible_from_module: Option<ModuleId>,
 438     name: Option<&Name>,
 439     mode: LookupMode,
 440     callback: &mut dyn FnMut(&Ty, AssocItemId) -> bool,
 441 ) -> bool {
 442     match mode {
 443         LookupMode::MethodCall => {
 444             // For method calls, rust first does any number of autoderef, and then one
 445             // autoref (i.e. when the method takes &self or &mut self). We just ignore
 446             // the autoref currently -- when we find a method matching the given name,
 447             // we assume it fits.
 448
 449             // Also note that when we've got a receiver like &S, even if the method we
 450             // find in the end takes &self, we still do the autoderef step (just as
 451             // rustc does an autoderef and then autoref again).
 452             let ty = InEnvironment { goal: ty.clone(), environment: env.env.clone() };
 453
 454             // We have to be careful about the order we're looking at candidates
 455             // in here. Consider the case where we're resolving `x.clone()`
 456             // where `x: &Vec<_>`. This resolves to the clone method with self
 457             // type `Vec<_>`, *not* `&_`. I.e. we need to consider methods where
 458             // the receiver type exactly matches before cases where we have to
 459             // do autoref. But in the autoderef steps, the `&_` self type comes
 460             // up *before* the `Vec<_>` self type.
 461             //
 462             // On the other hand, we don't want to just pick any by-value method
 463             // before any by-autoref method; it's just that we need to consider
 464             // the methods by autoderef order of *receiver types*, not *self
 465             // types*.
 466
 467             let deref_chain = autoderef_method_receiver(db, krate, ty);
 468             for i in 0..deref_chain.len() {
 469                 if iterate_method_candidates_with_autoref(
 470                     &deref_chain[i..],
 471                     db,
 472                     env.clone(),
 473                     krate,
 474                     traits_in_scope,
 475                     visible_from_module,
 476                     name,
 477                     callback,
 478                 ) {
 479                     return true;
 480                 }
 481             }
 482             false
 483         }
 484         LookupMode::Path => {
 485             // No autoderef for path lookups
 486             iterate_method_candidates_for_self_ty(
 487                 &ty,
 488                 db,
 489                 env,
 490                 krate,
 491                 traits_in_scope,
 492                 visible_from_module,
 493                 name,
 494                 callback,
 495             )
 496         }
 497     }
 498 }
 499
 500 fn iterate_method_candidates_with_autoref(
 501     deref_chain: &[Canonical<Ty>],
 502     db: &dyn HirDatabase,
 503     env: Arc<TraitEnvironment>,
 504     krate: CrateId,
 505     traits_in_scope: &FxHashSet<TraitId>,
 506     visible_from_module: Option<ModuleId>,
 507     name: Option<&Name>,
 508     mut callback: &mut dyn FnMut(&Ty, AssocItemId) -> bool,
 509 ) -> bool {
 510     if iterate_method_candidates_by_receiver(
 511         &deref_chain[0],
 512         &deref_chain[1..],
 513         db,
 514         env.clone(),
 515         krate,
 516         &traits_in_scope,
 517         visible_from_module,
 518         name,
 519         &mut callback,
 520     ) {
 521         return true;
 522     }
 523     let refed = Canonical {
 524         binders: deref_chain[0].binders.clone(),
 525         value: TyKind::Ref(Mutability::Not, static_lifetime(), deref_chain[0].value.clone())
 526             .intern(&Interner),
 527     };
 528     if iterate_method_candidates_by_receiver(
 529         &refed,
 530         deref_chain,
 531         db,
 532         env.clone(),
 533         krate,
 534         &traits_in_scope,
 535         visible_from_module,
 536         name,
 537         &mut callback,
 538     ) {
 539         return true;
 540     }
 541     let ref_muted = Canonical {
 542         binders: deref_chain[0].binders.clone(),
 543         value: TyKind::Ref(Mutability::Mut, static_lifetime(), deref_chain[0].value.clone())
 544             .intern(&Interner),
 545     };
 546     if iterate_method_candidates_by_receiver(
 547         &ref_muted,
 548         deref_chain,
 549         db,
 550         env,
 551         krate,
 552         &traits_in_scope,
 553         visible_from_module,
 554         name,
 555         &mut callback,
 556     ) {
 557         return true;
 558     }
 559     false
 560 }
 561
 562 fn iterate_method_candidates_by_receiver(
 563     receiver_ty: &Canonical<Ty>,
 564     rest_of_deref_chain: &[Canonical<Ty>],
 565     db: &dyn HirDatabase,
 566     env: Arc<TraitEnvironment>,
 567     krate: CrateId,
 568     traits_in_scope: &FxHashSet<TraitId>,
 569     visible_from_module: Option<ModuleId>,
 570     name: Option<&Name>,
 571     mut callback: &mut dyn FnMut(&Ty, AssocItemId) -> bool,
 572 ) -> bool {
 573     // We're looking for methods with *receiver* type receiver_ty. These could
 574     // be found in any of the derefs of receiver_ty, so we have to go through
 575     // that.
 576     for self_ty in std::iter::once(receiver_ty).chain(rest_of_deref_chain) {
 577         if iterate_inherent_methods(
 578             self_ty,
 579             db,
 580             name,
 581             Some(receiver_ty),
 582             krate,
 583             visible_from_module,
 584             &mut callback,
 585         ) {
 586             return true;
 587         }
 588     }
 589     for self_ty in std::iter::once(receiver_ty).chain(rest_of_deref_chain) {
 590         if iterate_trait_method_candidates(
 591             self_ty,
 592             db,
 593             env.clone(),
 594             krate,
 595             &traits_in_scope,
 596             name,
 597             Some(receiver_ty),
 598             &mut callback,
 599         ) {
 600             return true;
 601         }
 602     }
 603     false
 604 }
 605
 606 fn iterate_method_candidates_for_self_ty(
 607     self_ty: &Canonical<Ty>,
 608     db: &dyn HirDatabase,
 609     env: Arc<TraitEnvironment>,
 610     krate: CrateId,
 611     traits_in_scope: &FxHashSet<TraitId>,
 612     visible_from_module: Option<ModuleId>,
 613     name: Option<&Name>,
 614     mut callback: &mut dyn FnMut(&Ty, AssocItemId) -> bool,
 615 ) -> bool {
 616     if iterate_inherent_methods(self_ty, db, name, None, krate, visible_from_module, &mut callback)
 617     {
 618         return true;
 619     }
 620     iterate_trait_method_candidates(self_ty, db, env, krate, traits_in_scope, name, None, callback)
 621 }
 622
 623 fn iterate_trait_method_candidates(
 624     self_ty: &Canonical<Ty>,
 625     db: &dyn HirDatabase,
 626     env: Arc<TraitEnvironment>,
 627     krate: CrateId,
 628     traits_in_scope: &FxHashSet<TraitId>,
 629     name: Option<&Name>,
 630     receiver_ty: Option<&Canonical<Ty>>,
 631     callback: &mut dyn FnMut(&Ty, AssocItemId) -> bool,
 632 ) -> bool {
 633     // if ty is `dyn Trait`, the trait doesn't need to be in scope
 634     let inherent_trait =
 635         self_ty.value.dyn_trait().into_iter().flat_map(|t| all_super_traits(db.upcast(), t));
 636     let env_traits = if let TyKind::Placeholder(_) = self_ty.value.kind(&Interner) {
 637         // if we have `T: Trait` in the param env, the trait doesn't need to be in scope
 638         env.traits_in_scope_from_clauses(&self_ty.value)
 639             .flat_map(|t| all_super_traits(db.upcast(), t))
 640             .collect()
 641     } else {
 642         Vec::new()
 643     };
 644     let traits =
 645         inherent_trait.chain(env_traits.into_iter()).chain(traits_in_scope.iter().copied());
 646     'traits: for t in traits {
 647         let data = db.trait_data(t);
 648
 649         // we'll be lazy about checking whether the type implements the
 650         // trait, but if we find out it doesn't, we'll skip the rest of the
 651         // iteration
 652         let mut known_implemented = false;
 653         for (_name, item) in data.items.iter() {
 654             // Don't pass a `visible_from_module` down to `is_valid_candidate`,
 655             // since only inherent methods should be included into visibility checking.
 656             if !is_valid_candidate(db, name, receiver_ty, *item, self_ty, None) {
 657                 continue;
 658             }
 659             if !known_implemented {
 660                 let goal = generic_implements_goal(db, env.clone(), t, self_ty.clone());
 661                 if db.trait_solve(krate, goal).is_none() {
 662                     continue 'traits;
 663                 }
 664             }
 665             known_implemented = true;
 666             // FIXME: we shouldn't be ignoring the binders here
 667             if callback(&self_ty.value, *item) {
 668                 return true;
 669             }
 670         }
 671     }
 672     false
 673 }
 674
 675 fn iterate_inherent_methods(
 676     self_ty: &Canonical<Ty>,
 677     db: &dyn HirDatabase,
 678     name: Option<&Name>,
 679     receiver_ty: Option<&Canonical<Ty>>,
 680     krate: CrateId,
 681     visible_from_module: Option<ModuleId>,
 682     callback: &mut dyn FnMut(&Ty, AssocItemId) -> bool,
 683 ) -> bool {
 684     let def_crates = match def_crates(db, &self_ty.value, krate) {
 685         Some(k) => k,
 686         None => return false,
 687     };
 688     for krate in def_crates {
 689         let impls = db.inherent_impls_in_crate(krate);
 690
 691         for &impl_def in impls.for_self_ty(&self_ty.value) {
 692             for &item in db.impl_data(impl_def).items.iter() {
 693                 if !is_valid_candidate(db, name, receiver_ty, item, self_ty, visible_from_module) {
 694                     continue;
 695                 }
 696                 // we have to check whether the self type unifies with the type
 697                 // that the impl is for. If we have a receiver type, this
 698                 // already happens in `is_valid_candidate` above; if not, we
 699                 // check it here
 700                 if receiver_ty.is_none() && inherent_impl_substs(db, impl_def, self_ty).is_none() {
 701                     cov_mark::hit!(impl_self_type_match_without_receiver);
 702                     continue;
 703                 }
 704                 if callback(&self_ty.value, item) {
 705                     return true;
 706                 }
 707             }
 708         }
 709     }
 710     false
 711 }
 712
 713 /// Returns the self type for the index trait call.
 714 pub fn resolve_indexing_op(
 715     db: &dyn HirDatabase,
 716     ty: &Canonical<Ty>,
 717     env: Arc<TraitEnvironment>,
 718     krate: CrateId,
 719     index_trait: TraitId,
 720 ) -> Option<Canonical<Ty>> {
 721     let ty = InEnvironment { goal: ty.clone(), environment: env.env.clone() };
 722     let deref_chain = autoderef_method_receiver(db, krate, ty);
 723     for ty in deref_chain {
 724         let goal = generic_implements_goal(db, env.clone(), index_trait, ty.clone());
 725         if db.trait_solve(krate, goal).is_some() {
 726             return Some(ty);
 727         }
 728     }
 729     None
 730 }
 731
 732 fn is_valid_candidate(
 733     db: &dyn HirDatabase,
 734     name: Option<&Name>,
 735     receiver_ty: Option<&Canonical<Ty>>,
 736     item: AssocItemId,
 737     self_ty: &Canonical<Ty>,
 738     visible_from_module: Option<ModuleId>,
 739 ) -> bool {
 740     match item {
 741         AssocItemId::FunctionId(m) => {
 742             let data = db.function_data(m);
 743             if let Some(name) = name {
 744                 if &data.name != name {
 745                     return false;
 746                 }
 747             }
 748             if let Some(receiver_ty) = receiver_ty {
 749                 if !data.has_self_param() {
 750                     return false;
 751                 }
 752                 let transformed_receiver_ty = match transform_receiver_ty(db, m, self_ty) {
 753                     Some(ty) => ty,
 754                     None => return false,
 755                 };
 756                 if transformed_receiver_ty != receiver_ty.value {
 757                     return false;
 758                 }
 759             }
 760             if let Some(from_module) = visible_from_module {
 761                 if !db.function_visibility(m).is_visible_from(db.upcast(), from_module) {
 762                     cov_mark::hit!(autoderef_candidate_not_visible);
 763                     return false;
 764                 }
 765             }
 766
 767             true
 768         }
 769         AssocItemId::ConstId(c) => {
 770             let data = db.const_data(c);
 771             name.map_or(true, |name| data.name.as_ref() == Some(name)) && receiver_ty.is_none()
 772         }
 773         _ => false,
 774     }
 775 }
 776
 777 pub(crate) fn inherent_impl_substs(
 778     db: &dyn HirDatabase,
 779     impl_id: ImplId,
 780     self_ty: &Canonical<Ty>,
 781 ) -> Option<Substitution> {
 782     // we create a var for each type parameter of the impl; we need to keep in
 783     // mind here that `self_ty` might have vars of its own
 784     let self_ty_vars = self_ty.binders.len(&Interner);
 785     let vars = TyBuilder::subst_for_def(db, impl_id)
 786         .fill_with_bound_vars(DebruijnIndex::INNERMOST, self_ty_vars)
 787         .build();
 788     let self_ty_with_vars = db.impl_self_ty(impl_id).substitute(&Interner, &vars);
 789     let mut kinds = self_ty.binders.interned().to_vec();
 790     kinds.extend(
 791         iter::repeat(chalk_ir::WithKind::new(
 792             chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General),
 793             UniverseIndex::ROOT,
 794         ))
 795         .take(vars.len(&Interner)),
 796     );
 797     let tys = Canonical {
 798         binders: CanonicalVarKinds::from_iter(&Interner, kinds),
 799         value: (self_ty_with_vars, self_ty.value.clone()),
 800     };
 801     let substs = super::infer::unify(&tys)?;
 802     // We only want the substs for the vars we added, not the ones from self_ty.
 803     // Also, if any of the vars we added are still in there, we replace them by
 804     // Unknown. I think this can only really happen if self_ty contained
 805     // Unknown, and in that case we want the result to contain Unknown in those
 806     // places again.
 807     let suffix =
 808         Substitution::from_iter(&Interner, substs.iter(&Interner).cloned().skip(self_ty_vars));
 809     Some(fallback_bound_vars(suffix, self_ty_vars))
 810 }
 811
 812 /// This replaces any 'free' Bound vars in `s` (i.e. those with indices past
 813 /// num_vars_to_keep) by `TyKind::Unknown`.
 814 fn fallback_bound_vars(s: Substitution, num_vars_to_keep: usize) -> Substitution {
 815     crate::fold_free_vars(s, |bound, binders| {
 816         if bound.index >= num_vars_to_keep && bound.debruijn == DebruijnIndex::INNERMOST {
 817             TyKind::Error.intern(&Interner)
 818         } else {
 819             bound.shifted_in_from(binders).to_ty(&Interner)
 820         }
 821     })
 822 }
 823
 824 fn transform_receiver_ty(
 825     db: &dyn HirDatabase,
 826     function_id: FunctionId,
 827     self_ty: &Canonical<Ty>,
 828 ) -> Option<Ty> {
 829     let substs = match function_id.lookup(db.upcast()).container {
 830         AssocContainerId::TraitId(_) => TyBuilder::subst_for_def(db, function_id)
 831             .push(self_ty.value.clone())
 832             .fill_with_unknown()
 833             .build(),
 834         AssocContainerId::ImplId(impl_id) => {
 835             let impl_substs = inherent_impl_substs(db, impl_id, &self_ty)?;
 836             TyBuilder::subst_for_def(db, function_id)
 837                 .use_parent_substs(&impl_substs)
 838                 .fill_with_unknown()
 839                 .build()
 840         }
 841         AssocContainerId::ModuleId(_) => unreachable!(),
 842     };
 843     let sig = db.callable_item_signature(function_id.into());
 844     Some(sig.map(|s| s.params()[0].clone()).substitute(&Interner, &substs))
 845 }
 846
 847 pub fn implements_trait(
 848     ty: &Canonical<Ty>,
 849     db: &dyn HirDatabase,
 850     env: Arc<TraitEnvironment>,
 851     krate: CrateId,
 852     trait_: TraitId,
 853 ) -> bool {
 854     let goal = generic_implements_goal(db, env, trait_, ty.clone());
 855     let solution = db.trait_solve(krate, goal);
 856
 857     solution.is_some()
 858 }
 859
 860 pub fn implements_trait_unique(
 861     ty: &Canonical<Ty>,
 862     db: &dyn HirDatabase,
 863     env: Arc<TraitEnvironment>,
 864     krate: CrateId,
 865     trait_: TraitId,
 866 ) -> bool {
 867     let goal = generic_implements_goal(db, env, trait_, ty.clone());
 868     let solution = db.trait_solve(krate, goal);
 869
 870     matches!(solution, Some(crate::Solution::Unique(_)))
 871 }
 872
 873 /// This creates Substs for a trait with the given Self type and type variables
 874 /// for all other parameters, to query Chalk with it.
 875 fn generic_implements_goal(
 876     db: &dyn HirDatabase,
 877     env: Arc<TraitEnvironment>,
 878     trait_: TraitId,
 879     self_ty: Canonical<Ty>,
 880 ) -> Canonical<InEnvironment<super::DomainGoal>> {
 881     let mut kinds = self_ty.binders.interned().to_vec();
 882     let trait_ref = TyBuilder::trait_ref(db, trait_)
 883         .push(self_ty.value)
 884         .fill_with_bound_vars(DebruijnIndex::INNERMOST, kinds.len())
 885         .build();
 886     kinds.extend(
 887         iter::repeat(chalk_ir::WithKind::new(
 888             chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General),
 889             UniverseIndex::ROOT,
 890         ))
 891         .take(trait_ref.substitution.len(&Interner) - 1),
 892     );
 893     let obligation = trait_ref.cast(&Interner);
 894     Canonical {
 895         binders: CanonicalVarKinds::from_iter(&Interner, kinds),
 896         value: InEnvironment::new(&env.env, obligation),
 897     }
 898 }
 899
 900 fn autoderef_method_receiver(
 901     db: &dyn HirDatabase,
 902     krate: CrateId,
 903     ty: InEnvironment<Canonical<Ty>>,
 904 ) -> Vec<Canonical<Ty>> {
 905     let mut deref_chain: Vec<_> = autoderef::autoderef(db, Some(krate), ty).collect();
 906     // As a last step, we can do array unsizing (that's the only unsizing that rustc does for method receivers!)
 907     if let Some(TyKind::Array(parameters, _)) =
 908         deref_chain.last().map(|ty| ty.value.kind(&Interner))
 909     {
 910         let kinds = deref_chain.last().unwrap().binders.clone();
 911         let unsized_ty = TyKind::Slice(parameters.clone()).intern(&Interner);
 912         deref_chain.push(Canonical { value: unsized_ty, binders: kinds })
 913     }
 914     deref_chain
 915 }