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