compiler/rustc_hir/src/def.rs

   1 use crate::def_id::DefId;
   2 use crate::hir;
   3
   4 use rustc_ast as ast;
   5 use rustc_ast::NodeId;
   6 use rustc_macros::HashStable_Generic;
   7 use rustc_span::hygiene::MacroKind;
   8 use rustc_span::Symbol;
   9
  10 use std::array::IntoIter;
  11 use std::fmt::Debug;
  12
  13 /// Encodes if a `DefKind::Ctor` is the constructor of an enum variant or a struct.
  14 #[derive(Clone, Copy, PartialEq, Eq, Encodable, Decodable, Hash, Debug)]
  15 #[derive(HashStable_Generic)]
  16 pub enum CtorOf {
  17     /// This `DefKind::Ctor` is a synthesized constructor of a tuple or unit struct.
  18     Struct,
  19     /// This `DefKind::Ctor` is a synthesized constructor of a tuple or unit variant.
  20     Variant,
  21 }
  22
  23 /// What kind of constructor something is.
  24 #[derive(Clone, Copy, PartialEq, Eq, Encodable, Decodable, Hash, Debug)]
  25 #[derive(HashStable_Generic)]
  26 pub enum CtorKind {
  27     /// Constructor function automatically created by a tuple struct/variant.
  28     Fn,
  29     /// Constructor constant automatically created by a unit struct/variant.
  30     Const,
  31     /// Unusable name in value namespace created by a struct variant.
  32     Fictive,
  33 }
  34
  35 /// An attribute that is not a macro; e.g., `#[inline]` or `#[rustfmt::skip]`.
  36 #[derive(Clone, Copy, PartialEq, Eq, Encodable, Decodable, Hash, Debug)]
  37 #[derive(HashStable_Generic)]
  38 pub enum NonMacroAttrKind {
  39     /// Single-segment attribute defined by the language (`#[inline]`)
  40     Builtin(Symbol),
  41     /// Multi-segment custom attribute living in a "tool module" (`#[rustfmt::skip]`).
  42     Tool,
  43     /// Single-segment custom attribute registered by a derive macro (`#[serde(default)]`).
  44     DeriveHelper,
  45     /// Single-segment custom attribute registered by a derive macro
  46     /// but used before that derive macro was expanded (deprecated).
  47     DeriveHelperCompat,
  48     /// Single-segment custom attribute registered with `#[register_attr]`.
  49     Registered,
  50 }
  51
  52 /// What kind of definition something is; e.g., `mod` vs `struct`.
  53 #[derive(Clone, Copy, PartialEq, Eq, Encodable, Decodable, Hash, Debug)]
  54 #[derive(HashStable_Generic)]
  55 pub enum DefKind {
  56     // Type namespace
  57     Mod,
  58     /// Refers to the struct itself, [`DefKind::Ctor`] refers to its constructor if it exists.
  59     Struct,
  60     Union,
  61     Enum,
  62     /// Refers to the variant itself, [`DefKind::Ctor`] refers to its constructor if it exists.
  63     Variant,
  64     Trait,
  65     /// Type alias: `type Foo = Bar;`
  66     TyAlias,
  67     /// Type from an `extern` block.
  68     ForeignTy,
  69     /// Trait alias: `trait IntIterator = Iterator<Item = i32>;`
  70     TraitAlias,
  71     /// Associated type: `trait MyTrait { type Assoc; }`
  72     AssocTy,
  73     /// Type parameter: the `T` in `struct Vec<T> { ... }`
  74     TyParam,
  75
  76     // Value namespace
  77     Fn,
  78     Const,
  79     /// Constant generic parameter: `struct Foo<const N: usize> { ... }`
  80     ConstParam,
  81     Static(ast::Mutability),
  82     /// Refers to the struct or enum variant's constructor.
  83     ///
  84     /// The reason `Ctor` exists in addition to [`DefKind::Struct`] and
  85     /// [`DefKind::Variant`] is because structs and enum variants exist
  86     /// in the *type* namespace, whereas struct and enum variant *constructors*
  87     /// exist in the *value* namespace.
  88     ///
  89     /// You may wonder why enum variants exist in the type namespace as opposed
  90     /// to the value namespace. Check out [RFC 2593] for intuition on why that is.
  91     ///
  92     /// [RFC 2593]: https://github.com/rust-lang/rfcs/pull/2593
  93     Ctor(CtorOf, CtorKind),
  94     /// Associated function: `impl MyStruct { fn associated() {} }`
  95     AssocFn,
  96     /// Associated constant: `trait MyTrait { const ASSOC: usize; }`
  97     AssocConst,
  98
  99     // Macro namespace
 100     Macro(MacroKind),
 101
 102     // Not namespaced (or they are, but we don't treat them so)
 103     ExternCrate,
 104     Use,
 105     /// An `extern` block.
 106     ForeignMod,
 107     /// Anonymous constant, e.g. the `1 + 2` in `[u8; 1 + 2]`
 108     AnonConst,
 109     /// An inline constant, e.g. `const { 1 + 2 }`
 110     InlineConst,
 111     /// Opaque type, aka `impl Trait`.
 112     OpaqueTy,
 113     Field,
 114     /// Lifetime parameter: the `'a` in `struct Foo<'a> { ... }`
 115     LifetimeParam,
 116     /// A use of `global_asm!`.
 117     GlobalAsm,
 118     Impl,
 119     Closure,
 120     Generator,
 121 }
 122
 123 impl DefKind {
 124     pub fn descr(self, def_id: DefId) -> &'static str {
 125         match self {
 126             DefKind::Fn => "function",
 127             DefKind::Mod if def_id.is_crate_root() && !def_id.is_local() => "crate",
 128             DefKind::Mod => "module",
 129             DefKind::Static(..) => "static",
 130             DefKind::Enum => "enum",
 131             DefKind::Variant => "variant",
 132             DefKind::Ctor(CtorOf::Variant, CtorKind::Fn) => "tuple variant",
 133             DefKind::Ctor(CtorOf::Variant, CtorKind::Const) => "unit variant",
 134             DefKind::Ctor(CtorOf::Variant, CtorKind::Fictive) => "struct variant",
 135             DefKind::Struct => "struct",
 136             DefKind::Ctor(CtorOf::Struct, CtorKind::Fn) => "tuple struct",
 137             DefKind::Ctor(CtorOf::Struct, CtorKind::Const) => "unit struct",
 138             DefKind::Ctor(CtorOf::Struct, CtorKind::Fictive) => {
 139                 panic!("impossible struct constructor")
 140             }
 141             DefKind::OpaqueTy => "opaque type",
 142             DefKind::TyAlias => "type alias",
 143             DefKind::TraitAlias => "trait alias",
 144             DefKind::AssocTy => "associated type",
 145             DefKind::Union => "union",
 146             DefKind::Trait => "trait",
 147             DefKind::ForeignTy => "foreign type",
 148             DefKind::AssocFn => "associated function",
 149             DefKind::Const => "constant",
 150             DefKind::AssocConst => "associated constant",
 151             DefKind::TyParam => "type parameter",
 152             DefKind::ConstParam => "const parameter",
 153             DefKind::Macro(macro_kind) => macro_kind.descr(),
 154             DefKind::LifetimeParam => "lifetime parameter",
 155             DefKind::Use => "import",
 156             DefKind::ForeignMod => "foreign module",
 157             DefKind::AnonConst => "constant expression",
 158             DefKind::InlineConst => "inline constant",
 159             DefKind::Field => "field",
 160             DefKind::Impl => "implementation",
 161             DefKind::Closure => "closure",
 162             DefKind::Generator => "generator",
 163             DefKind::ExternCrate => "extern crate",
 164             DefKind::GlobalAsm => "global assembly block",
 165         }
 166     }
 167
 168     /// Gets an English article for the definition.
 169     pub fn article(&self) -> &'static str {
 170         match *self {
 171             DefKind::AssocTy
 172             | DefKind::AssocConst
 173             | DefKind::AssocFn
 174             | DefKind::Enum
 175             | DefKind::OpaqueTy
 176             | DefKind::Impl
 177             | DefKind::Use
 178             | DefKind::InlineConst
 179             | DefKind::ExternCrate => "an",
 180             DefKind::Macro(macro_kind) => macro_kind.article(),
 181             _ => "a",
 182         }
 183     }
 184
 185     pub fn ns(&self) -> Option<Namespace> {
 186         match self {
 187             DefKind::Mod
 188             | DefKind::Struct
 189             | DefKind::Union
 190             | DefKind::Enum
 191             | DefKind::Variant
 192             | DefKind::Trait
 193             | DefKind::OpaqueTy
 194             | DefKind::TyAlias
 195             | DefKind::ForeignTy
 196             | DefKind::TraitAlias
 197             | DefKind::AssocTy
 198             | DefKind::TyParam => Some(Namespace::TypeNS),
 199
 200             DefKind::Fn
 201             | DefKind::Const
 202             | DefKind::ConstParam
 203             | DefKind::Static(..)
 204             | DefKind::Ctor(..)
 205             | DefKind::AssocFn
 206             | DefKind::AssocConst => Some(Namespace::ValueNS),
 207
 208             DefKind::Macro(..) => Some(Namespace::MacroNS),
 209
 210             // Not namespaced.
 211             DefKind::AnonConst
 212             | DefKind::InlineConst
 213             | DefKind::Field
 214             | DefKind::LifetimeParam
 215             | DefKind::ExternCrate
 216             | DefKind::Closure
 217             | DefKind::Generator
 218             | DefKind::Use
 219             | DefKind::ForeignMod
 220             | DefKind::GlobalAsm
 221             | DefKind::Impl => None,
 222         }
 223     }
 224
 225     #[inline]
 226     pub fn is_fn_like(self) -> bool {
 227         match self {
 228             DefKind::Fn | DefKind::AssocFn | DefKind::Closure | DefKind::Generator => true,
 229             _ => false,
 230         }
 231     }
 232 }
 233
 234 /// The resolution of a path or export.
 235 ///
 236 /// For every path or identifier in Rust, the compiler must determine
 237 /// what the path refers to. This process is called name resolution,
 238 /// and `Res` is the primary result of name resolution.
 239 ///
 240 /// For example, everything prefixed with `/* Res */` in this example has
 241 /// an associated `Res`:
 242 ///
 243 /// ```
 244 /// fn str_to_string(s: & /* Res */ str) -> /* Res */ String {
 245 ///     /* Res */ String::from(/* Res */ s)
 246 /// }
 247 ///
 248 /// /* Res */ str_to_string("hello");
 249 /// ```
 250 ///
 251 /// The associated `Res`s will be:
 252 ///
 253 /// - `str` will resolve to [`Res::PrimTy`];
 254 /// - `String` will resolve to [`Res::Def`], and the `Res` will include the [`DefId`]
 255 ///   for `String` as defined in the standard library;
 256 /// - `String::from` will also resolve to [`Res::Def`], with the [`DefId`]
 257 ///   pointing to `String::from`;
 258 /// - `s` will resolve to [`Res::Local`];
 259 /// - the call to `str_to_string` will resolve to [`Res::Def`], with the [`DefId`]
 260 ///   pointing to the definition of `str_to_string` in the current crate.
 261 //
 262 #[derive(Clone, Copy, PartialEq, Eq, Encodable, Decodable, Hash, Debug)]
 263 #[derive(HashStable_Generic)]
 264 pub enum Res<Id = hir::HirId> {
 265     /// Definition having a unique ID (`DefId`), corresponds to something defined in user code.
 266     ///
 267     /// **Not bound to a specific namespace.**
 268     Def(DefKind, DefId),
 269
 270     // Type namespace
 271     /// A primitive type such as `i32` or `str`.
 272     ///
 273     /// **Belongs to the type namespace.**
 274     PrimTy(hir::PrimTy),
 275     /// The `Self` type, optionally with the [`DefId`] of the trait it belongs to and
 276     /// optionally with the [`DefId`] of the item introducing the `Self` type alias.
 277     ///
 278     /// **Belongs to the type namespace.**
 279     ///
 280     /// Examples:
 281     /// ```
 282     /// struct Bar(Box<Self>);
 283     /// // `Res::SelfTy { trait_: None, alias_of: Some(Bar) }`
 284     ///
 285     /// trait Foo {
 286     ///     fn foo() -> Box<Self>;
 287     ///     // `Res::SelfTy { trait_: Some(Foo), alias_of: None }`
 288     /// }
 289     ///
 290     /// impl Bar {
 291     ///     fn blah() {
 292     ///         let _: Self;
 293     ///         // `Res::SelfTy { trait_: None, alias_of: Some(::{impl#0}) }`
 294     ///     }
 295     /// }
 296     ///
 297     /// impl Foo for Bar {
 298     ///     fn foo() -> Box<Self> {
 299     ///     // `Res::SelfTy { trait_: Some(Foo), alias_of: Some(::{impl#1}) }`
 300     ///         let _: Self;
 301     ///         // `Res::SelfTy { trait_: Some(Foo), alias_of: Some(::{impl#1}) }`
 302     ///
 303     ///         todo!()
 304     ///     }
 305     /// }
 306     /// ```
 307     ///
 308     /// *See also [`Res::SelfCtor`].*
 309     ///
 310     /// -----
 311     ///
 312     /// HACK(min_const_generics): self types also have an optional requirement to **not** mention
 313     /// any generic parameters to allow the following with `min_const_generics`:
 314     /// ```
 315     /// # struct Foo;
 316     /// impl Foo { fn test() -> [u8; std::mem::size_of::<Self>()] { todo!() } }
 317     ///
 318     /// struct Bar([u8; baz::<Self>()]);
 319     /// const fn baz<T>() -> usize { 10 }
 320     /// ```
 321     /// We do however allow `Self` in repeat expression even if it is generic to not break code
 322     /// which already works on stable while causing the `const_evaluatable_unchecked` future compat lint:
 323     /// ```
 324     /// fn foo<T>() {
 325     ///     let _bar = [1_u8; std::mem::size_of::<*mut T>()];
 326     /// }
 327     /// ```
 328     // FIXME(generic_const_exprs): Remove this bodge once that feature is stable.
 329     SelfTy {
 330         /// The trait this `Self` is a generic arg for.
 331         trait_: Option<DefId>,
 332         /// The item introducing the `Self` type alias. Can be used in the `type_of` query
 333         /// to get the underlying type. Additionally whether the `Self` type is disallowed
 334         /// from mentioning generics (i.e. when used in an anonymous constant).
 335         alias_to: Option<(DefId, bool)>,
 336     },
 337     /// A tool attribute module; e.g., the `rustfmt` in `#[rustfmt::skip]`.
 338     ///
 339     /// **Belongs to the type namespace.**
 340     ToolMod,
 341
 342     // Value namespace
 343     /// The `Self` constructor, along with the [`DefId`]
 344     /// of the impl it is associated with.
 345     ///
 346     /// **Belongs to the value namespace.**
 347     ///
 348     /// *See also [`Res::SelfTy`].*
 349     SelfCtor(DefId),
 350     /// A local variable or function parameter.
 351     ///
 352     /// **Belongs to the value namespace.**
 353     Local(Id),
 354
 355     // Macro namespace
 356     /// An attribute that is *not* implemented via macro.
 357     /// E.g., `#[inline]` and `#[rustfmt::skip]`, which are essentially directives,
 358     /// as opposed to `#[test]`, which is a builtin macro.
 359     ///
 360     /// **Belongs to the macro namespace.**
 361     NonMacroAttr(NonMacroAttrKind), // e.g., `#[inline]` or `#[rustfmt::skip]`
 362
 363     // All namespaces
 364     /// Name resolution failed. We use a dummy `Res` variant so later phases
 365     /// of the compiler won't crash and can instead report more errors.
 366     ///
 367     /// **Not bound to a specific namespace.**
 368     Err,
 369 }
 370
 371 /// The result of resolving a path before lowering to HIR,
 372 /// with "module" segments resolved and associated item
 373 /// segments deferred to type checking.
 374 /// `base_res` is the resolution of the resolved part of the
 375 /// path, `unresolved_segments` is the number of unresolved
 376 /// segments.
 377 ///
 378 /// ```text
 379 /// module::Type::AssocX::AssocY::MethodOrAssocType
 380 /// ^~~~~~~~~~~~  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 381 /// base_res      unresolved_segments = 3
 382 ///
 383 /// <T as Trait>::AssocX::AssocY::MethodOrAssocType
 384 ///       ^~~~~~~~~~~~~~  ^~~~~~~~~~~~~~~~~~~~~~~~~
 385 ///       base_res        unresolved_segments = 2
 386 /// ```
 387 #[derive(Copy, Clone, Debug)]
 388 pub struct PartialRes {
 389     base_res: Res<NodeId>,
 390     unresolved_segments: usize,
 391 }
 392
 393 impl PartialRes {
 394     #[inline]
 395     pub fn new(base_res: Res<NodeId>) -> Self {
 396         PartialRes { base_res, unresolved_segments: 0 }
 397     }
 398
 399     #[inline]
 400     pub fn with_unresolved_segments(base_res: Res<NodeId>, mut unresolved_segments: usize) -> Self {
 401         if base_res == Res::Err {
 402             unresolved_segments = 0
 403         }
 404         PartialRes { base_res, unresolved_segments }
 405     }
 406
 407     #[inline]
 408     pub fn base_res(&self) -> Res<NodeId> {
 409         self.base_res
 410     }
 411
 412     #[inline]
 413     pub fn unresolved_segments(&self) -> usize {
 414         self.unresolved_segments
 415     }
 416 }
 417
 418 /// Different kinds of symbols can coexist even if they share the same textual name.
 419 /// Therefore, they each have a separate universe (known as a "namespace").
 420 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 421 pub enum Namespace {
 422     /// The type namespace includes `struct`s, `enum`s, `union`s, `trait`s, and `mod`s
 423     /// (and, by extension, crates).
 424     ///
 425     /// Note that the type namespace includes other items; this is not an
 426     /// exhaustive list.
 427     TypeNS,
 428     /// The value namespace includes `fn`s, `const`s, `static`s, and local variables (including function arguments).
 429     ValueNS,
 430     /// The macro namespace includes `macro_rules!` macros, declarative `macro`s,
 431     /// procedural macros, attribute macros, `derive` macros, and non-macro attributes
 432     /// like `#[inline]` and `#[rustfmt::skip]`.
 433     MacroNS,
 434 }
 435
 436 impl Namespace {
 437     /// The English description of the namespace.
 438     pub fn descr(self) -> &'static str {
 439         match self {
 440             Self::TypeNS => "type",
 441             Self::ValueNS => "value",
 442             Self::MacroNS => "macro",
 443         }
 444     }
 445 }
 446
 447 /// Just a helper ‒ separate structure for each namespace.
 448 #[derive(Copy, Clone, Default, Debug)]
 449 pub struct PerNS<T> {
 450     pub value_ns: T,
 451     pub type_ns: T,
 452     pub macro_ns: T,
 453 }
 454
 455 impl<T> PerNS<T> {
 456     pub fn map<U, F: FnMut(T) -> U>(self, mut f: F) -> PerNS<U> {
 457         PerNS { value_ns: f(self.value_ns), type_ns: f(self.type_ns), macro_ns: f(self.macro_ns) }
 458     }
 459
 460     pub fn into_iter(self) -> IntoIter<T, 3> {
 461         [self.value_ns, self.type_ns, self.macro_ns].into_iter()
 462     }
 463
 464     pub fn iter(&self) -> IntoIter<&T, 3> {
 465         [&self.value_ns, &self.type_ns, &self.macro_ns].into_iter()
 466     }
 467 }
 468
 469 impl<T> ::std::ops::Index<Namespace> for PerNS<T> {
 470     type Output = T;
 471
 472     fn index(&self, ns: Namespace) -> &T {
 473         match ns {
 474             Namespace::ValueNS => &self.value_ns,
 475             Namespace::TypeNS => &self.type_ns,
 476             Namespace::MacroNS => &self.macro_ns,
 477         }
 478     }
 479 }
 480
 481 impl<T> ::std::ops::IndexMut<Namespace> for PerNS<T> {
 482     fn index_mut(&mut self, ns: Namespace) -> &mut T {
 483         match ns {
 484             Namespace::ValueNS => &mut self.value_ns,
 485             Namespace::TypeNS => &mut self.type_ns,
 486             Namespace::MacroNS => &mut self.macro_ns,
 487         }
 488     }
 489 }
 490
 491 impl<T> PerNS<Option<T>> {
 492     /// Returns `true` if all the items in this collection are `None`.
 493     pub fn is_empty(&self) -> bool {
 494         self.type_ns.is_none() && self.value_ns.is_none() && self.macro_ns.is_none()
 495     }
 496
 497     /// Returns an iterator over the items which are `Some`.
 498     pub fn present_items(self) -> impl Iterator<Item = T> {
 499         [self.type_ns, self.value_ns, self.macro_ns].into_iter().flatten()
 500     }
 501 }
 502
 503 impl CtorKind {
 504     pub fn from_ast(vdata: &ast::VariantData) -> CtorKind {
 505         match *vdata {
 506             ast::VariantData::Tuple(..) => CtorKind::Fn,
 507             ast::VariantData::Unit(..) => CtorKind::Const,
 508             ast::VariantData::Struct(..) => CtorKind::Fictive,
 509         }
 510     }
 511
 512     pub fn from_hir(vdata: &hir::VariantData<'_>) -> CtorKind {
 513         match *vdata {
 514             hir::VariantData::Tuple(..) => CtorKind::Fn,
 515             hir::VariantData::Unit(..) => CtorKind::Const,
 516             hir::VariantData::Struct(..) => CtorKind::Fictive,
 517         }
 518     }
 519 }
 520
 521 impl NonMacroAttrKind {
 522     pub fn descr(self) -> &'static str {
 523         match self {
 524             NonMacroAttrKind::Builtin(..) => "built-in attribute",
 525             NonMacroAttrKind::Tool => "tool attribute",
 526             NonMacroAttrKind::DeriveHelper | NonMacroAttrKind::DeriveHelperCompat => {
 527                 "derive helper attribute"
 528             }
 529             NonMacroAttrKind::Registered => "explicitly registered attribute",
 530         }
 531     }
 532
 533     pub fn article(self) -> &'static str {
 534         match self {
 535             NonMacroAttrKind::Registered => "an",
 536             _ => "a",
 537         }
 538     }
 539
 540     /// Users of some attributes cannot mark them as used, so they are considered always used.
 541     pub fn is_used(self) -> bool {
 542         match self {
 543             NonMacroAttrKind::Tool
 544             | NonMacroAttrKind::DeriveHelper
 545             | NonMacroAttrKind::DeriveHelperCompat => true,
 546             NonMacroAttrKind::Builtin(..) | NonMacroAttrKind::Registered => false,
 547         }
 548     }
 549 }
 550
 551 impl<Id> Res<Id> {
 552     /// Return the `DefId` of this `Def` if it has an ID, else panic.
 553     pub fn def_id(&self) -> DefId
 554     where
 555         Id: Debug,
 556     {
 557         self.opt_def_id()
 558             .unwrap_or_else(|| panic!("attempted .def_id() on invalid res: {:?}", self))
 559     }
 560
 561     /// Return `Some(..)` with the `DefId` of this `Res` if it has a ID, else `None`.
 562     pub fn opt_def_id(&self) -> Option<DefId> {
 563         match *self {
 564             Res::Def(_, id) => Some(id),
 565
 566             Res::Local(..)
 567             | Res::PrimTy(..)
 568             | Res::SelfTy { .. }
 569             | Res::SelfCtor(..)
 570             | Res::ToolMod
 571             | Res::NonMacroAttr(..)
 572             | Res::Err => None,
 573         }
 574     }
 575
 576     /// Return the `DefId` of this `Res` if it represents a module.
 577     pub fn mod_def_id(&self) -> Option<DefId> {
 578         match *self {
 579             Res::Def(DefKind::Mod, id) => Some(id),
 580             _ => None,
 581         }
 582     }
 583
 584     /// A human readable name for the res kind ("function", "module", etc.).
 585     pub fn descr(&self) -> &'static str {
 586         match *self {
 587             Res::Def(kind, def_id) => kind.descr(def_id),
 588             Res::SelfCtor(..) => "self constructor",
 589             Res::PrimTy(..) => "builtin type",
 590             Res::Local(..) => "local variable",
 591             Res::SelfTy { .. } => "self type",
 592             Res::ToolMod => "tool module",
 593             Res::NonMacroAttr(attr_kind) => attr_kind.descr(),
 594             Res::Err => "unresolved item",
 595         }
 596     }
 597
 598     /// Gets an English article for the `Res`.
 599     pub fn article(&self) -> &'static str {
 600         match *self {
 601             Res::Def(kind, _) => kind.article(),
 602             Res::NonMacroAttr(kind) => kind.article(),
 603             Res::Err => "an",
 604             _ => "a",
 605         }
 606     }
 607
 608     pub fn map_id<R>(self, mut map: impl FnMut(Id) -> R) -> Res<R> {
 609         match self {
 610             Res::Def(kind, id) => Res::Def(kind, id),
 611             Res::SelfCtor(id) => Res::SelfCtor(id),
 612             Res::PrimTy(id) => Res::PrimTy(id),
 613             Res::Local(id) => Res::Local(map(id)),
 614             Res::SelfTy { trait_, alias_to } => Res::SelfTy { trait_, alias_to },
 615             Res::ToolMod => Res::ToolMod,
 616             Res::NonMacroAttr(attr_kind) => Res::NonMacroAttr(attr_kind),
 617             Res::Err => Res::Err,
 618         }
 619     }
 620
 621     pub fn apply_id<R, E>(self, mut map: impl FnMut(Id) -> Result<R, E>) -> Result<Res<R>, E> {
 622         Ok(match self {
 623             Res::Def(kind, id) => Res::Def(kind, id),
 624             Res::SelfCtor(id) => Res::SelfCtor(id),
 625             Res::PrimTy(id) => Res::PrimTy(id),
 626             Res::Local(id) => Res::Local(map(id)?),
 627             Res::SelfTy { trait_, alias_to } => Res::SelfTy { trait_, alias_to },
 628             Res::ToolMod => Res::ToolMod,
 629             Res::NonMacroAttr(attr_kind) => Res::NonMacroAttr(attr_kind),
 630             Res::Err => Res::Err,
 631         })
 632     }
 633
 634     #[track_caller]
 635     pub fn expect_non_local<OtherId>(self) -> Res<OtherId> {
 636         self.map_id(|_| panic!("unexpected `Res::Local`"))
 637     }
 638
 639     pub fn macro_kind(self) -> Option<MacroKind> {
 640         match self {
 641             Res::Def(DefKind::Macro(kind), _) => Some(kind),
 642             Res::NonMacroAttr(..) => Some(MacroKind::Attr),
 643             _ => None,
 644         }
 645     }
 646
 647     /// Returns `None` if this is `Res::Err`
 648     pub fn ns(&self) -> Option<Namespace> {
 649         match self {
 650             Res::Def(kind, ..) => kind.ns(),
 651             Res::PrimTy(..) | Res::SelfTy { .. } | Res::ToolMod => Some(Namespace::TypeNS),
 652             Res::SelfCtor(..) | Res::Local(..) => Some(Namespace::ValueNS),
 653             Res::NonMacroAttr(..) => Some(Namespace::MacroNS),
 654             Res::Err => None,
 655         }
 656     }
 657
 658     /// Always returns `true` if `self` is `Res::Err`
 659     pub fn matches_ns(&self, ns: Namespace) -> bool {
 660         self.ns().map_or(true, |actual_ns| actual_ns == ns)
 661     }
 662
 663     /// Returns whether such a resolved path can occur in a tuple struct/variant pattern
 664     pub fn expected_in_tuple_struct_pat(&self) -> bool {
 665         matches!(self, Res::Def(DefKind::Ctor(_, CtorKind::Fn), _) | Res::SelfCtor(..))
 666     }
 667
 668     /// Returns whether such a resolved path can occur in a unit struct/variant pattern
 669     pub fn expected_in_unit_struct_pat(&self) -> bool {
 670         matches!(self, Res::Def(DefKind::Ctor(_, CtorKind::Const), _) | Res::SelfCtor(..))
 671     }
 672 }