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, ops::ControlFlow, 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             if let Some(it) = callback(ty, item) {
 439                 slot = Some(it);
 440                 return ControlFlow::Break(());
 441             }
 442             ControlFlow::Continue(())
 443         },
 444     );
 445     slot
 446 }
 447
 448 pub fn iterate_method_candidates_dyn(
 449     ty: &Canonical<Ty>,
 450     db: &dyn HirDatabase,
 451     env: Arc<TraitEnvironment>,
 452     krate: CrateId,
 453     traits_in_scope: &FxHashSet<TraitId>,
 454     visible_from_module: Option<ModuleId>,
 455     name: Option<&Name>,
 456     mode: LookupMode,
 457     callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
 458 ) -> ControlFlow<()> {
 459     match mode {
 460         LookupMode::MethodCall => {
 461             // For method calls, rust first does any number of autoderef, and then one
 462             // autoref (i.e. when the method takes &self or &mut self). We just ignore
 463             // the autoref currently -- when we find a method matching the given name,
 464             // we assume it fits.
 465
 466             // Also note that when we've got a receiver like &S, even if the method we
 467             // find in the end takes &self, we still do the autoderef step (just as
 468             // rustc does an autoderef and then autoref again).
 469             let ty = InEnvironment { goal: ty.clone(), environment: env.env.clone() };
 470
 471             // We have to be careful about the order we're looking at candidates
 472             // in here. Consider the case where we're resolving `x.clone()`
 473             // where `x: &Vec<_>`. This resolves to the clone method with self
 474             // type `Vec<_>`, *not* `&_`. I.e. we need to consider methods where
 475             // the receiver type exactly matches before cases where we have to
 476             // do autoref. But in the autoderef steps, the `&_` self type comes
 477             // up *before* the `Vec<_>` self type.
 478             //
 479             // On the other hand, we don't want to just pick any by-value method
 480             // before any by-autoref method; it's just that we need to consider
 481             // the methods by autoderef order of *receiver types*, not *self
 482             // types*.
 483
 484             let deref_chain = autoderef_method_receiver(db, krate, ty);
 485             for i in 0..deref_chain.len() {
 486                 iterate_method_candidates_with_autoref(
 487                     &deref_chain[i..],
 488                     db,
 489                     env.clone(),
 490                     krate,
 491                     traits_in_scope,
 492                     visible_from_module,
 493                     name,
 494                     callback,
 495                 )?;
 496             }
 497             ControlFlow::Continue(())
 498         }
 499         LookupMode::Path => {
 500             // No autoderef for path lookups
 501             iterate_method_candidates_for_self_ty(
 502                 ty,
 503                 db,
 504                 env,
 505                 krate,
 506                 traits_in_scope,
 507                 visible_from_module,
 508                 name,
 509                 callback,
 510             )
 511         }
 512     }
 513 }
 514
 515 fn iterate_method_candidates_with_autoref(
 516     deref_chain: &[Canonical<Ty>],
 517     db: &dyn HirDatabase,
 518     env: Arc<TraitEnvironment>,
 519     krate: CrateId,
 520     traits_in_scope: &FxHashSet<TraitId>,
 521     visible_from_module: Option<ModuleId>,
 522     name: Option<&Name>,
 523     mut callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
 524 ) -> ControlFlow<()> {
 525     iterate_method_candidates_by_receiver(
 526         &deref_chain[0],
 527         &deref_chain[1..],
 528         db,
 529         env.clone(),
 530         krate,
 531         traits_in_scope,
 532         visible_from_module,
 533         name,
 534         &mut callback,
 535     )?;
 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
 543     iterate_method_candidates_by_receiver(
 544         &refed,
 545         deref_chain,
 546         db,
 547         env.clone(),
 548         krate,
 549         traits_in_scope,
 550         visible_from_module,
 551         name,
 552         &mut callback,
 553     )?;
 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
 561     iterate_method_candidates_by_receiver(
 562         &ref_muted,
 563         deref_chain,
 564         db,
 565         env,
 566         krate,
 567         traits_in_scope,
 568         visible_from_module,
 569         name,
 570         &mut callback,
 571     )
 572 }
 573
 574 fn iterate_method_candidates_by_receiver(
 575     receiver_ty: &Canonical<Ty>,
 576     rest_of_deref_chain: &[Canonical<Ty>],
 577     db: &dyn HirDatabase,
 578     env: Arc<TraitEnvironment>,
 579     krate: CrateId,
 580     traits_in_scope: &FxHashSet<TraitId>,
 581     visible_from_module: Option<ModuleId>,
 582     name: Option<&Name>,
 583     mut callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
 584 ) -> ControlFlow<()> {
 585     // We're looking for methods with *receiver* type receiver_ty. These could
 586     // be found in any of the derefs of receiver_ty, so we have to go through
 587     // that.
 588     for self_ty in std::iter::once(receiver_ty).chain(rest_of_deref_chain) {
 589         iterate_inherent_methods(
 590             self_ty,
 591             db,
 592             env.clone(),
 593             name,
 594             Some(receiver_ty),
 595             krate,
 596             visible_from_module,
 597             &mut callback,
 598         )?
 599     }
 600
 601     for self_ty in std::iter::once(receiver_ty).chain(rest_of_deref_chain) {
 602         iterate_trait_method_candidates(
 603             self_ty,
 604             db,
 605             env.clone(),
 606             krate,
 607             traits_in_scope,
 608             name,
 609             Some(receiver_ty),
 610             &mut callback,
 611         )?
 612     }
 613
 614     ControlFlow::Continue(())
 615 }
 616
 617 fn iterate_method_candidates_for_self_ty(
 618     self_ty: &Canonical<Ty>,
 619     db: &dyn HirDatabase,
 620     env: Arc<TraitEnvironment>,
 621     krate: CrateId,
 622     traits_in_scope: &FxHashSet<TraitId>,
 623     visible_from_module: Option<ModuleId>,
 624     name: Option<&Name>,
 625     mut callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
 626 ) -> ControlFlow<()> {
 627     iterate_inherent_methods(
 628         self_ty,
 629         db,
 630         env.clone(),
 631         name,
 632         None,
 633         krate,
 634         visible_from_module,
 635         &mut callback,
 636     )?;
 637     iterate_trait_method_candidates(self_ty, db, env, krate, traits_in_scope, name, None, callback)
 638 }
 639
 640 fn iterate_trait_method_candidates(
 641     self_ty: &Canonical<Ty>,
 642     db: &dyn HirDatabase,
 643     env: Arc<TraitEnvironment>,
 644     krate: CrateId,
 645     traits_in_scope: &FxHashSet<TraitId>,
 646     name: Option<&Name>,
 647     receiver_ty: Option<&Canonical<Ty>>,
 648     callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
 649 ) -> ControlFlow<()> {
 650     let receiver_is_array = matches!(self_ty.value.kind(&Interner), chalk_ir::TyKind::Array(..));
 651     // if ty is `dyn Trait`, the trait doesn't need to be in scope
 652     let inherent_trait =
 653         self_ty.value.dyn_trait().into_iter().flat_map(|t| all_super_traits(db.upcast(), t));
 654     let env_traits = match self_ty.value.kind(&Interner) {
 655         TyKind::Placeholder(_) => {
 656             // if we have `T: Trait` in the param env, the trait doesn't need to be in scope
 657             env.traits_in_scope_from_clauses(&self_ty.value)
 658                 .flat_map(|t| all_super_traits(db.upcast(), t))
 659                 .collect()
 660         }
 661         _ => Vec::new(),
 662     };
 663     let traits =
 664         inherent_trait.chain(env_traits.into_iter()).chain(traits_in_scope.iter().copied());
 665
 666     'traits: for t in traits {
 667         let data = db.trait_data(t);
 668
 669         // Traits annotated with `#[rustc_skip_array_during_method_dispatch]` are skipped during
 670         // method resolution, if the receiver is an array, and we're compiling for editions before
 671         // 2021.
 672         // This is to make `[a].into_iter()` not break code with the new `IntoIterator` impl for
 673         // arrays.
 674         if data.skip_array_during_method_dispatch && receiver_is_array {
 675             // FIXME: this should really be using the edition of the method name's span, in case it
 676             // comes from a macro
 677             if db.crate_graph()[krate].edition < Edition::Edition2021 {
 678                 continue;
 679             }
 680         }
 681
 682         // we'll be lazy about checking whether the type implements the
 683         // trait, but if we find out it doesn't, we'll skip the rest of the
 684         // iteration
 685         let mut known_implemented = false;
 686         for (_name, item) in data.items.iter() {
 687             // Don't pass a `visible_from_module` down to `is_valid_candidate`,
 688             // since only inherent methods should be included into visibility checking.
 689             if !is_valid_candidate(db, env.clone(), name, receiver_ty, *item, self_ty, None) {
 690                 continue;
 691             }
 692             if !known_implemented {
 693                 let goal = generic_implements_goal(db, env.clone(), t, self_ty.clone());
 694                 if db.trait_solve(krate, goal.cast(&Interner)).is_none() {
 695                     continue 'traits;
 696                 }
 697             }
 698             known_implemented = true;
 699             // FIXME: we shouldn't be ignoring the binders here
 700             callback(&self_ty.value, *item)?
 701         }
 702     }
 703     ControlFlow::Continue(())
 704 }
 705
 706 fn filter_inherent_impls_for_self_ty<'i>(
 707     impls: &'i InherentImpls,
 708     self_ty: &Ty,
 709 ) -> impl Iterator<Item = &'i ImplId> {
 710     // inherent methods on arrays are fingerprinted as [T; {unknown}], so we must also consider them when
 711     // resolving a method call on an array with a known len
 712     let array_impls = {
 713         if let TyKind::Array(parameters, array_len) = self_ty.kind(&Interner) {
 714             if !array_len.is_unknown() {
 715                 let unknown_array_len_ty =
 716                     TyKind::Array(parameters.clone(), consteval::usize_const(None))
 717                         .intern(&Interner);
 718
 719                 Some(impls.for_self_ty(&unknown_array_len_ty))
 720             } else {
 721                 None
 722             }
 723         } else {
 724             None
 725         }
 726     }
 727     .into_iter()
 728     .flatten();
 729
 730     impls.for_self_ty(self_ty).iter().chain(array_impls)
 731 }
 732
 733 fn iterate_inherent_methods(
 734     self_ty: &Canonical<Ty>,
 735     db: &dyn HirDatabase,
 736     env: Arc<TraitEnvironment>,
 737     name: Option<&Name>,
 738     receiver_ty: Option<&Canonical<Ty>>,
 739     krate: CrateId,
 740     visible_from_module: Option<ModuleId>,
 741     callback: &mut dyn FnMut(&Ty, AssocItemId) -> ControlFlow<()>,
 742 ) -> ControlFlow<()> {
 743     let def_crates = match def_crates(db, &self_ty.value, krate) {
 744         Some(k) => k,
 745         None => return ControlFlow::Continue(()),
 746     };
 747
 748     for krate in def_crates {
 749         let impls = db.inherent_impls_in_crate(krate);
 750
 751         let impls_for_self_ty = filter_inherent_impls_for_self_ty(&impls, &self_ty.value);
 752
 753         for &impl_def in impls_for_self_ty {
 754             for &item in db.impl_data(impl_def).items.iter() {
 755                 if !is_valid_candidate(
 756                     db,
 757                     env.clone(),
 758                     name,
 759                     receiver_ty,
 760                     item,
 761                     self_ty,
 762                     visible_from_module,
 763                 ) {
 764                     continue;
 765                 }
 766                 // we have to check whether the self type unifies with the type
 767                 // that the impl is for. If we have a receiver type, this
 768                 // already happens in `is_valid_candidate` above; if not, we
 769                 // check it here
 770                 if receiver_ty.is_none()
 771                     && inherent_impl_substs(db, env.clone(), impl_def, self_ty).is_none()
 772                 {
 773                     cov_mark::hit!(impl_self_type_match_without_receiver);
 774                     continue;
 775                 }
 776                 let receiver_ty = receiver_ty.map(|x| &x.value).unwrap_or(&self_ty.value);
 777                 callback(receiver_ty, item)?;
 778             }
 779         }
 780     }
 781     ControlFlow::Continue(())
 782 }
 783
 784 /// Returns the self type for the index trait call.
 785 pub fn resolve_indexing_op(
 786     db: &dyn HirDatabase,
 787     ty: &Canonical<Ty>,
 788     env: Arc<TraitEnvironment>,
 789     krate: CrateId,
 790     index_trait: TraitId,
 791 ) -> Option<Canonical<Ty>> {
 792     let ty = InEnvironment { goal: ty.clone(), environment: env.env.clone() };
 793     let deref_chain = autoderef_method_receiver(db, krate, ty);
 794     for ty in deref_chain {
 795         let goal = generic_implements_goal(db, env.clone(), index_trait, ty.clone());
 796         if db.trait_solve(krate, goal.cast(&Interner)).is_some() {
 797             return Some(ty);
 798         }
 799     }
 800     None
 801 }
 802
 803 fn is_transformed_receiver_ty_equal(transformed_receiver_ty: &Ty, receiver_ty: &Ty) -> bool {
 804     if transformed_receiver_ty == receiver_ty {
 805         return true;
 806     }
 807
 808     // a transformed receiver may be considered equal (and a valid method call candidate) if it is an array
 809     // with an unknown (i.e. generic) length, and the receiver is an array with the same item type but a known len,
 810     // this allows inherent methods on arrays to be considered valid resolution candidates
 811     match (transformed_receiver_ty.kind(&Interner), receiver_ty.kind(&Interner)) {
 812         (
 813             TyKind::Array(transformed_array_ty, transformed_array_len),
 814             TyKind::Array(receiver_array_ty, receiver_array_len),
 815         ) if transformed_array_ty == receiver_array_ty
 816             && transformed_array_len.is_unknown()
 817             && !receiver_array_len.is_unknown() =>
 818         {
 819             true
 820         }
 821         _ => false,
 822     }
 823 }
 824
 825 fn is_valid_candidate(
 826     db: &dyn HirDatabase,
 827     env: Arc<TraitEnvironment>,
 828     name: Option<&Name>,
 829     receiver_ty: Option<&Canonical<Ty>>,
 830     item: AssocItemId,
 831     self_ty: &Canonical<Ty>,
 832     visible_from_module: Option<ModuleId>,
 833 ) -> bool {
 834     match item {
 835         AssocItemId::FunctionId(m) => {
 836             let data = db.function_data(m);
 837             if let Some(name) = name {
 838                 if &data.name != name {
 839                     return false;
 840                 }
 841             }
 842             if let Some(receiver_ty) = receiver_ty {
 843                 if !data.has_self_param() {
 844                     return false;
 845                 }
 846                 let transformed_receiver_ty = match transform_receiver_ty(db, env, m, self_ty) {
 847                     Some(ty) => ty,
 848                     None => return false,
 849                 };
 850
 851                 if !is_transformed_receiver_ty_equal(&transformed_receiver_ty, &receiver_ty.value) {
 852                     return false;
 853                 }
 854             }
 855             if let Some(from_module) = visible_from_module {
 856                 if !db.function_visibility(m).is_visible_from(db.upcast(), from_module) {
 857                     cov_mark::hit!(autoderef_candidate_not_visible);
 858                     return false;
 859                 }
 860             }
 861
 862             true
 863         }
 864         AssocItemId::ConstId(c) => {
 865             let data = db.const_data(c);
 866             name.map_or(true, |name| data.name.as_ref() == Some(name)) && receiver_ty.is_none()
 867         }
 868         _ => false,
 869     }
 870 }
 871
 872 pub(crate) fn inherent_impl_substs(
 873     db: &dyn HirDatabase,
 874     env: Arc<TraitEnvironment>,
 875     impl_id: ImplId,
 876     self_ty: &Canonical<Ty>,
 877 ) -> Option<Substitution> {
 878     // we create a var for each type parameter of the impl; we need to keep in
 879     // mind here that `self_ty` might have vars of its own
 880     let self_ty_vars = self_ty.binders.len(&Interner);
 881     let vars = TyBuilder::subst_for_def(db, impl_id)
 882         .fill_with_bound_vars(DebruijnIndex::INNERMOST, self_ty_vars)
 883         .build();
 884     let self_ty_with_vars = db.impl_self_ty(impl_id).substitute(&Interner, &vars);
 885     let mut kinds = self_ty.binders.interned().to_vec();
 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(vars.len(&Interner)),
 892     );
 893     let tys = Canonical {
 894         binders: CanonicalVarKinds::from_iter(&Interner, kinds),
 895         value: (self_ty_with_vars, self_ty.value.clone()),
 896     };
 897     let substs = super::infer::unify(db, env, &tys)?;
 898     // We only want the substs for the vars we added, not the ones from self_ty.
 899     // Also, if any of the vars we added are still in there, we replace them by
 900     // Unknown. I think this can only really happen if self_ty contained
 901     // Unknown, and in that case we want the result to contain Unknown in those
 902     // places again.
 903     let suffix =
 904         Substitution::from_iter(&Interner, substs.iter(&Interner).cloned().skip(self_ty_vars));
 905     Some(fallback_bound_vars(suffix, self_ty_vars))
 906 }
 907
 908 /// This replaces any 'free' Bound vars in `s` (i.e. those with indices past
 909 /// num_vars_to_keep) by `TyKind::Unknown`.
 910 fn fallback_bound_vars(s: Substitution, num_vars_to_keep: usize) -> Substitution {
 911     crate::fold_free_vars(s, |bound, binders| {
 912         if bound.index >= num_vars_to_keep && bound.debruijn == DebruijnIndex::INNERMOST {
 913             TyKind::Error.intern(&Interner)
 914         } else {
 915             bound.shifted_in_from(binders).to_ty(&Interner)
 916         }
 917     })
 918 }
 919
 920 fn transform_receiver_ty(
 921     db: &dyn HirDatabase,
 922     env: Arc<TraitEnvironment>,
 923     function_id: FunctionId,
 924     self_ty: &Canonical<Ty>,
 925 ) -> Option<Ty> {
 926     let substs = match function_id.lookup(db.upcast()).container {
 927         AssocContainerId::TraitId(_) => TyBuilder::subst_for_def(db, function_id)
 928             .push(self_ty.value.clone())
 929             .fill_with_unknown()
 930             .build(),
 931         AssocContainerId::ImplId(impl_id) => {
 932             let impl_substs = inherent_impl_substs(db, env, impl_id, self_ty)?;
 933             TyBuilder::subst_for_def(db, function_id)
 934                 .use_parent_substs(&impl_substs)
 935                 .fill_with_unknown()
 936                 .build()
 937         }
 938         AssocContainerId::ModuleId(_) => unreachable!(),
 939     };
 940     let sig = db.callable_item_signature(function_id.into());
 941     Some(sig.map(|s| s.params()[0].clone()).substitute(&Interner, &substs))
 942 }
 943
 944 pub fn implements_trait(
 945     ty: &Canonical<Ty>,
 946     db: &dyn HirDatabase,
 947     env: Arc<TraitEnvironment>,
 948     krate: CrateId,
 949     trait_: TraitId,
 950 ) -> bool {
 951     let goal = generic_implements_goal(db, env, trait_, ty.clone());
 952     let solution = db.trait_solve(krate, goal.cast(&Interner));
 953
 954     solution.is_some()
 955 }
 956
 957 pub fn implements_trait_unique(
 958     ty: &Canonical<Ty>,
 959     db: &dyn HirDatabase,
 960     env: Arc<TraitEnvironment>,
 961     krate: CrateId,
 962     trait_: TraitId,
 963 ) -> bool {
 964     let goal = generic_implements_goal(db, env, trait_, ty.clone());
 965     let solution = db.trait_solve(krate, goal.cast(&Interner));
 966
 967     matches!(solution, Some(crate::Solution::Unique(_)))
 968 }
 969
 970 /// This creates Substs for a trait with the given Self type and type variables
 971 /// for all other parameters, to query Chalk with it.
 972 fn generic_implements_goal(
 973     db: &dyn HirDatabase,
 974     env: Arc<TraitEnvironment>,
 975     trait_: TraitId,
 976     self_ty: Canonical<Ty>,
 977 ) -> Canonical<InEnvironment<super::DomainGoal>> {
 978     let mut kinds = self_ty.binders.interned().to_vec();
 979     let trait_ref = TyBuilder::trait_ref(db, trait_)
 980         .push(self_ty.value)
 981         .fill_with_bound_vars(DebruijnIndex::INNERMOST, kinds.len())
 982         .build();
 983     kinds.extend(
 984         iter::repeat(chalk_ir::WithKind::new(
 985             chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General),
 986             UniverseIndex::ROOT,
 987         ))
 988         .take(trait_ref.substitution.len(&Interner) - 1),
 989     );
 990     let obligation = trait_ref.cast(&Interner);
 991     Canonical {
 992         binders: CanonicalVarKinds::from_iter(&Interner, kinds),
 993         value: InEnvironment::new(&env.env, obligation),
 994     }
 995 }
 996
 997 fn autoderef_method_receiver(
 998     db: &dyn HirDatabase,
 999     krate: CrateId,
1000     ty: InEnvironment<Canonical<Ty>>,
1001 ) -> Vec<Canonical<Ty>> {
1002     let mut deref_chain: Vec<_> = autoderef::autoderef(db, Some(krate), ty).collect();
1003     // As a last step, we can do array unsizing (that's the only unsizing that rustc does for method receivers!)
1004     if let Some(TyKind::Array(parameters, _)) =
1005         deref_chain.last().map(|ty| ty.value.kind(&Interner))
1006     {
1007         let kinds = deref_chain.last().unwrap().binders.clone();
1008         let unsized_ty = TyKind::Slice(parameters.clone()).intern(&Interner);
1009         deref_chain.push(Canonical { value: unsized_ty, binders: kinds })
1010     }
1011     deref_chain
1012 }