1 use std::cell::RefCell;
2 use std::default::Default;
4 use std::path::PathBuf;
7 use std::sync::OnceLock as OnceCell;
8 use std::{cmp, fmt, iter};
10 use arrayvec::ArrayVec;
11 use thin_vec::ThinVec;
13 use rustc_ast::util::comments::beautify_doc_string;
14 use rustc_ast::{self as ast, AttrStyle};
15 use rustc_attr::{ConstStability, Deprecation, Stability, StabilityLevel};
16 use rustc_const_eval::const_eval::is_unstable_const_fn;
17 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
19 use rustc_hir::def::{CtorKind, DefKind, Res};
20 use rustc_hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
21 use rustc_hir::lang_items::LangItem;
22 use rustc_hir::{BodyId, Mutability};
23 use rustc_hir_analysis::check::intrinsic::intrinsic_operation_unsafety;
24 use rustc_index::vec::IndexVec;
25 use rustc_middle::ty::fast_reject::SimplifiedType;
26 use rustc_middle::ty::{self, DefIdTree, TyCtxt, Visibility};
27 use rustc_session::Session;
28 use rustc_span::hygiene::MacroKind;
29 use rustc_span::symbol::{kw, sym, Ident, Symbol};
30 use rustc_span::{self, FileName, Loc};
31 use rustc_target::abi::VariantIdx;
32 use rustc_target::spec::abi::Abi;
34 use crate::clean::cfg::Cfg;
35 use crate::clean::external_path;
36 use crate::clean::inline::{self, print_inlined_const};
37 use crate::clean::utils::{is_literal_expr, print_const_expr, print_evaluated_const};
38 use crate::core::DocContext;
39 use crate::formats::cache::Cache;
40 use crate::formats::item_type::ItemType;
41 use crate::html::render::Context;
42 use crate::passes::collect_intra_doc_links::UrlFragment;
44 pub(crate) use self::FnRetTy::*;
45 pub(crate) use self::ItemKind::*;
46 pub(crate) use self::SelfTy::*;
47 pub(crate) use self::Type::{
48 Array, BareFunction, BorrowedRef, DynTrait, Generic, ImplTrait, Infer, Primitive, QPath,
49 RawPointer, Slice, Tuple,
55 pub(crate) type ItemIdSet = FxHashSet<ItemId>;
57 #[derive(Debug, Clone, PartialEq, Eq, Hash, Copy)]
58 pub(crate) enum ItemId {
59 /// A "normal" item that uses a [`DefId`] for identification.
61 /// Identifier that is used for auto traits.
62 Auto { trait_: DefId, for_: DefId },
63 /// Identifier that is used for blanket implementations.
64 Blanket { impl_id: DefId, for_: DefId },
69 pub(crate) fn is_local(self) -> bool {
71 ItemId::Auto { for_: id, .. }
72 | ItemId::Blanket { for_: id, .. }
73 | ItemId::DefId(id) => id.is_local(),
79 pub(crate) fn expect_def_id(self) -> DefId {
81 .unwrap_or_else(|| panic!("ItemId::expect_def_id: `{:?}` isn't a DefId", self))
85 pub(crate) fn as_def_id(self) -> Option<DefId> {
87 ItemId::DefId(id) => Some(id),
93 pub(crate) fn krate(self) -> CrateNum {
95 ItemId::Auto { for_: id, .. }
96 | ItemId::Blanket { for_: id, .. }
97 | ItemId::DefId(id) => id.krate,
102 impl From<DefId> for ItemId {
103 fn from(id: DefId) -> Self {
108 /// The crate currently being documented.
109 #[derive(Clone, Debug)]
110 pub(crate) struct Crate {
111 pub(crate) module: Item,
112 /// Only here so that they can be filtered through the rustdoc passes.
113 pub(crate) external_traits: Rc<RefCell<FxHashMap<DefId, Trait>>>,
117 pub(crate) fn name(&self, tcx: TyCtxt<'_>) -> Symbol {
118 ExternalCrate::LOCAL.name(tcx)
121 pub(crate) fn src(&self, tcx: TyCtxt<'_>) -> FileName {
122 ExternalCrate::LOCAL.src(tcx)
126 #[derive(Copy, Clone, Debug)]
127 pub(crate) struct ExternalCrate {
128 pub(crate) crate_num: CrateNum,
132 const LOCAL: Self = Self { crate_num: LOCAL_CRATE };
135 pub(crate) fn def_id(&self) -> DefId {
136 self.crate_num.as_def_id()
139 pub(crate) fn src(&self, tcx: TyCtxt<'_>) -> FileName {
140 let krate_span = tcx.def_span(self.def_id());
141 tcx.sess.source_map().span_to_filename(krate_span)
144 pub(crate) fn name(&self, tcx: TyCtxt<'_>) -> Symbol {
145 tcx.crate_name(self.crate_num)
148 pub(crate) fn src_root(&self, tcx: TyCtxt<'_>) -> PathBuf {
149 match self.src(tcx) {
150 FileName::Real(ref p) => match p.local_path_if_available().parent() {
151 Some(p) => p.to_path_buf(),
152 None => PathBuf::new(),
158 /// Attempts to find where an external crate is located, given that we're
159 /// rendering in to the specified source destination.
160 pub(crate) fn location(
162 extern_url: Option<&str>,
163 extern_url_takes_precedence: bool,
164 dst: &std::path::Path,
166 ) -> ExternalLocation {
167 use ExternalLocation::*;
169 fn to_remote(url: impl ToString) -> ExternalLocation {
170 let mut url = url.to_string();
171 if !url.ends_with('/') {
177 // See if there's documentation generated into the local directory
178 // WARNING: since rustdoc creates these directories as it generates documentation, this check is only accurate before rendering starts.
179 // Make sure to call `location()` by that time.
180 let local_location = dst.join(self.name(tcx).as_str());
181 if local_location.is_dir() {
185 if extern_url_takes_precedence {
186 if let Some(url) = extern_url {
187 return to_remote(url);
191 // Failing that, see if there's an attribute specifying where to find this
193 let did = self.crate_num.as_def_id();
194 tcx.get_attrs(did, sym::doc)
195 .flat_map(|attr| attr.meta_item_list().unwrap_or_default())
196 .filter(|a| a.has_name(sym::html_root_url))
197 .filter_map(|a| a.value_str())
200 .or_else(|| extern_url.map(to_remote)) // NOTE: only matters if `extern_url_takes_precedence` is false
201 .unwrap_or(Unknown) // Well, at least we tried.
204 pub(crate) fn keywords(&self, tcx: TyCtxt<'_>) -> ThinVec<(DefId, Symbol)> {
205 let root = self.def_id();
207 let as_keyword = |res: Res<!>| {
208 if let Res::Def(DefKind::Mod, def_id) = res {
209 let mut keyword = None;
211 .get_attrs(def_id, sym::doc)
212 .flat_map(|attr| attr.meta_item_list().unwrap_or_default());
213 for meta in meta_items {
214 if meta.has_name(sym::keyword) {
215 if let Some(v) = meta.value_str() {
221 return keyword.map(|p| (def_id, p));
231 let item = tcx.hir().item(id);
233 hir::ItemKind::Mod(_) => {
234 as_keyword(Res::Def(DefKind::Mod, id.owner_id.to_def_id()))
236 hir::ItemKind::Use(path, hir::UseKind::Single)
237 if tcx.visibility(id.owner_id).is_public() =>
241 .find_map(|res| as_keyword(res.expect_non_local()))
242 .map(|(_, prim)| (id.owner_id.to_def_id(), prim))
249 tcx.module_children(root).iter().map(|item| item.res).filter_map(as_keyword).collect()
253 pub(crate) fn primitives(&self, tcx: TyCtxt<'_>) -> ThinVec<(DefId, PrimitiveType)> {
254 let root = self.def_id();
256 // Collect all inner modules which are tagged as implementations of
259 // Note that this loop only searches the top-level items of the crate,
260 // and this is intentional. If we were to search the entire crate for an
261 // item tagged with `#[doc(primitive)]` then we would also have to
262 // search the entirety of external modules for items tagged
263 // `#[doc(primitive)]`, which is a pretty inefficient process (decoding
264 // all that metadata unconditionally).
266 // In order to keep the metadata load under control, the
267 // `#[doc(primitive)]` feature is explicitly designed to only allow the
268 // primitive tags to show up as the top level items in a crate.
270 // Also note that this does not attempt to deal with modules tagged
271 // duplicately for the same primitive. This is handled later on when
272 // rendering by delegating everything to a hash map.
273 let as_primitive = |res: Res<!>| {
274 if let Res::Def(DefKind::Mod, def_id) = res {
277 .get_attrs(def_id, sym::doc)
278 .flat_map(|attr| attr.meta_item_list().unwrap_or_default());
279 for meta in meta_items {
280 if let Some(v) = meta.value_str() {
281 if meta.has_name(sym::primitive) {
282 prim = PrimitiveType::from_symbol(v);
286 // FIXME: should warn on unknown primitives?
290 return prim.map(|p| (def_id, p));
301 let item = tcx.hir().item(id);
303 hir::ItemKind::Mod(_) => {
304 as_primitive(Res::Def(DefKind::Mod, id.owner_id.to_def_id()))
306 hir::ItemKind::Use(path, hir::UseKind::Single)
307 if tcx.visibility(id.owner_id).is_public() =>
311 .find_map(|res| as_primitive(res.expect_non_local()))
312 // Pretend the primitive is local.
313 .map(|(_, prim)| (id.owner_id.to_def_id(), prim))
320 tcx.module_children(root).iter().map(|item| item.res).filter_map(as_primitive).collect()
325 /// Indicates where an external crate can be found.
327 pub(crate) enum ExternalLocation {
328 /// Remote URL root of the external crate
330 /// This external crate can be found in the local doc/ folder
332 /// The external crate could not be found.
336 /// Anything with a source location and set of attributes and, optionally, a
337 /// name. That is, anything that can be documented. This doesn't correspond
338 /// directly to the AST's concept of an item; it's a strict superset.
340 pub(crate) struct Item {
341 /// The name of this item.
342 /// Optional because not every item has a name, e.g. impls.
343 pub(crate) name: Option<Symbol>,
344 pub(crate) attrs: Box<Attributes>,
345 /// Information about this item that is specific to what kind of item it is.
346 /// E.g., struct vs enum vs function.
347 pub(crate) kind: Box<ItemKind>,
348 pub(crate) item_id: ItemId,
349 /// This is the `DefId` of the `use` statement if the item was inlined.
350 pub(crate) inline_stmt_id: Option<DefId>,
351 pub(crate) cfg: Option<Arc<Cfg>>,
354 /// NOTE: this does NOT unconditionally print every item, to avoid thousands of lines of logs.
355 /// If you want to see the debug output for attributes and the `kind` as well, use `{:#?}` instead of `{:?}`.
356 impl fmt::Debug for Item {
357 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
358 let alternate = f.alternate();
359 // hand-picked fields that don't bloat the logs too much
360 let mut fmt = f.debug_struct("Item");
361 fmt.field("name", &self.name).field("item_id", &self.item_id);
362 // allow printing the full item if someone really wants to
364 fmt.field("attrs", &self.attrs).field("kind", &self.kind).field("cfg", &self.cfg);
366 fmt.field("kind", &self.type_());
367 fmt.field("docs", &self.doc_value());
373 pub(crate) fn rustc_span(def_id: DefId, tcx: TyCtxt<'_>) -> Span {
374 Span::new(def_id.as_local().map_or_else(
375 || tcx.def_span(def_id),
378 hir.span_with_body(hir.local_def_id_to_hir_id(local))
383 fn is_field_vis_inherited(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
384 let parent = tcx.parent(def_id);
385 match tcx.def_kind(parent) {
386 DefKind::Struct | DefKind::Union => false,
387 DefKind::Variant => true,
388 parent_kind => panic!("unexpected parent kind: {:?}", parent_kind),
393 pub(crate) fn stability<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Option<Stability> {
394 self.item_id.as_def_id().and_then(|did| tcx.lookup_stability(did))
397 pub(crate) fn const_stability<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Option<ConstStability> {
398 self.item_id.as_def_id().and_then(|did| tcx.lookup_const_stability(did))
401 pub(crate) fn deprecation(&self, tcx: TyCtxt<'_>) -> Option<Deprecation> {
402 self.item_id.as_def_id().and_then(|did| tcx.lookup_deprecation(did))
405 pub(crate) fn inner_docs(&self, tcx: TyCtxt<'_>) -> bool {
408 .map(|did| tcx.get_attrs_unchecked(did).inner_docs())
412 pub(crate) fn span(&self, tcx: TyCtxt<'_>) -> Option<Span> {
413 let kind = match &*self.kind {
414 ItemKind::StrippedItem(k) => k,
418 ItemKind::ModuleItem(Module { span, .. }) => Some(*span),
419 ItemKind::ImplItem(box Impl { kind: ImplKind::Auto, .. }) => None,
420 ItemKind::ImplItem(box Impl { kind: ImplKind::Blanket(_), .. }) => {
421 if let ItemId::Blanket { impl_id, .. } = self.item_id {
422 Some(rustc_span(impl_id, tcx))
424 panic!("blanket impl item has non-blanket ID")
427 _ => self.item_id.as_def_id().map(|did| rustc_span(did, tcx)),
431 pub(crate) fn attr_span(&self, tcx: TyCtxt<'_>) -> rustc_span::Span {
432 crate::passes::span_of_attrs(&self.attrs)
433 .unwrap_or_else(|| self.span(tcx).map_or(rustc_span::DUMMY_SP, |span| span.inner()))
436 /// Finds the `doc` attribute as a NameValue and returns the corresponding
438 pub(crate) fn doc_value(&self) -> Option<String> {
439 self.attrs.doc_value()
442 /// Convenience wrapper around [`Self::from_def_id_and_parts`] which converts
443 /// `hir_id` to a [`DefId`]
444 pub(crate) fn from_hir_id_and_parts(
446 name: Option<Symbol>,
448 cx: &mut DocContext<'_>,
450 Item::from_def_id_and_parts(cx.tcx.hir().local_def_id(hir_id).to_def_id(), name, kind, cx)
453 pub(crate) fn from_def_id_and_parts(
455 name: Option<Symbol>,
457 cx: &mut DocContext<'_>,
459 let ast_attrs = cx.tcx.get_attrs_unchecked(def_id);
461 Self::from_def_id_and_attrs_and_parts(
465 Box::new(Attributes::from_ast(ast_attrs)),
466 ast_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
470 pub(crate) fn from_def_id_and_attrs_and_parts(
472 name: Option<Symbol>,
474 attrs: Box<Attributes>,
475 cfg: Option<Arc<Cfg>>,
477 trace!("name={:?}, def_id={:?} cfg={:?}", name, def_id, cfg);
480 item_id: def_id.into(),
481 kind: Box::new(kind),
485 inline_stmt_id: None,
489 /// Finds all `doc` attributes as NameValues and returns their corresponding values, joined
491 pub(crate) fn collapsed_doc_value(&self) -> Option<String> {
492 self.attrs.collapsed_doc_value()
495 pub(crate) fn links(&self, cx: &Context<'_>) -> Vec<RenderedLink> {
496 use crate::html::format::href;
501 .map_or(&[][..], |v| v.as_slice())
503 .filter_map(|ItemLink { link: s, link_text, page_id: did, ref fragment }| {
505 if let Ok((mut href, ..)) = href(*did, cx) {
507 if let Some(ref fragment) = *fragment {
508 fragment.render(&mut href, cx.tcx())
511 original_text: s.clone(),
512 new_text: link_text.clone(),
522 /// Find a list of all link names, without finding their href.
524 /// This is used for generating summary text, which does not include
525 /// the link text, but does need to know which `[]`-bracketed names
526 /// are actually links.
527 pub(crate) fn link_names(&self, cache: &Cache) -> Vec<RenderedLink> {
531 .map_or(&[][..], |v| v.as_slice())
533 .map(|ItemLink { link: s, link_text, .. }| RenderedLink {
534 original_text: s.clone(),
535 new_text: link_text.clone(),
541 pub(crate) fn is_crate(&self) -> bool {
542 self.is_mod() && self.item_id.as_def_id().map_or(false, |did| did.is_crate_root())
544 pub(crate) fn is_mod(&self) -> bool {
545 self.type_() == ItemType::Module
547 pub(crate) fn is_trait(&self) -> bool {
548 self.type_() == ItemType::Trait
550 pub(crate) fn is_struct(&self) -> bool {
551 self.type_() == ItemType::Struct
553 pub(crate) fn is_enum(&self) -> bool {
554 self.type_() == ItemType::Enum
556 pub(crate) fn is_variant(&self) -> bool {
557 self.type_() == ItemType::Variant
559 pub(crate) fn is_associated_type(&self) -> bool {
560 matches!(&*self.kind, AssocTypeItem(..) | StrippedItem(box AssocTypeItem(..)))
562 pub(crate) fn is_ty_associated_type(&self) -> bool {
563 matches!(&*self.kind, TyAssocTypeItem(..) | StrippedItem(box TyAssocTypeItem(..)))
565 pub(crate) fn is_associated_const(&self) -> bool {
566 matches!(&*self.kind, AssocConstItem(..) | StrippedItem(box AssocConstItem(..)))
568 pub(crate) fn is_ty_associated_const(&self) -> bool {
569 matches!(&*self.kind, TyAssocConstItem(..) | StrippedItem(box TyAssocConstItem(..)))
571 pub(crate) fn is_method(&self) -> bool {
572 self.type_() == ItemType::Method
574 pub(crate) fn is_ty_method(&self) -> bool {
575 self.type_() == ItemType::TyMethod
577 pub(crate) fn is_typedef(&self) -> bool {
578 self.type_() == ItemType::Typedef
580 pub(crate) fn is_primitive(&self) -> bool {
581 self.type_() == ItemType::Primitive
583 pub(crate) fn is_union(&self) -> bool {
584 self.type_() == ItemType::Union
586 pub(crate) fn is_import(&self) -> bool {
587 self.type_() == ItemType::Import
589 pub(crate) fn is_extern_crate(&self) -> bool {
590 self.type_() == ItemType::ExternCrate
592 pub(crate) fn is_keyword(&self) -> bool {
593 self.type_() == ItemType::Keyword
595 pub(crate) fn is_stripped(&self) -> bool {
597 StrippedItem(..) => true,
598 ImportItem(ref i) => !i.should_be_displayed,
602 pub(crate) fn has_stripped_entries(&self) -> Option<bool> {
604 StructItem(ref struct_) => Some(struct_.has_stripped_entries()),
605 UnionItem(ref union_) => Some(union_.has_stripped_entries()),
606 EnumItem(ref enum_) => Some(enum_.has_stripped_entries()),
607 VariantItem(ref v) => v.has_stripped_entries(),
612 pub(crate) fn stability_class(&self, tcx: TyCtxt<'_>) -> Option<String> {
613 self.stability(tcx).as_ref().and_then(|s| {
614 let mut classes = Vec::with_capacity(2);
617 classes.push("unstable");
620 // FIXME: what about non-staged API items that are deprecated?
621 if self.deprecation(tcx).is_some() {
622 classes.push("deprecated");
625 if !classes.is_empty() { Some(classes.join(" ")) } else { None }
629 pub(crate) fn stable_since(&self, tcx: TyCtxt<'_>) -> Option<Symbol> {
630 match self.stability(tcx)?.level {
631 StabilityLevel::Stable { since, .. } => Some(since),
632 StabilityLevel::Unstable { .. } => None,
636 pub(crate) fn const_stable_since(&self, tcx: TyCtxt<'_>) -> Option<Symbol> {
637 match self.const_stability(tcx)?.level {
638 StabilityLevel::Stable { since, .. } => Some(since),
639 StabilityLevel::Unstable { .. } => None,
643 pub(crate) fn is_non_exhaustive(&self) -> bool {
644 self.attrs.other_attrs.iter().any(|a| a.has_name(sym::non_exhaustive))
647 /// Returns a documentation-level item type from the item.
648 pub(crate) fn type_(&self) -> ItemType {
652 pub(crate) fn is_default(&self) -> bool {
654 ItemKind::MethodItem(_, Some(defaultness)) => {
655 defaultness.has_value() && !defaultness.is_final()
661 /// Returns a `FnHeader` if `self` is a function item, otherwise returns `None`.
662 pub(crate) fn fn_header(&self, tcx: TyCtxt<'_>) -> Option<hir::FnHeader> {
666 asyncness: hir::IsAsync,
668 let sig = tcx.fn_sig(def_id);
670 if tcx.is_const_fn(def_id) && is_unstable_const_fn(tcx, def_id).is_none() {
671 hir::Constness::Const
673 hir::Constness::NotConst
675 hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness }
677 let header = match *self.kind {
678 ItemKind::ForeignFunctionItem(_) => {
679 let def_id = self.item_id.as_def_id().unwrap();
680 let abi = tcx.fn_sig(def_id).abi();
682 unsafety: if abi == Abi::RustIntrinsic {
683 intrinsic_operation_unsafety(tcx, self.item_id.as_def_id().unwrap())
685 hir::Unsafety::Unsafe
688 constness: if abi == Abi::RustIntrinsic
689 && tcx.is_const_fn(def_id)
690 && is_unstable_const_fn(tcx, def_id).is_none()
692 hir::Constness::Const
694 hir::Constness::NotConst
696 asyncness: hir::IsAsync::NotAsync,
699 ItemKind::FunctionItem(_) | ItemKind::MethodItem(_, _) | ItemKind::TyMethodItem(_) => {
700 let def_id = self.item_id.as_def_id().unwrap();
701 build_fn_header(def_id, tcx, tcx.asyncness(def_id))
708 /// Returns the visibility of the current item. If the visibility is "inherited", then `None`
710 pub(crate) fn visibility(&self, tcx: TyCtxt<'_>) -> Option<Visibility<DefId>> {
711 let def_id = match self.item_id {
712 // Anything but DefId *shouldn't* matter, but return a reasonable value anyway.
713 ItemId::Auto { .. } | ItemId::Blanket { .. } => return None,
714 ItemId::DefId(def_id) => def_id,
718 // Primitives and Keywords are written in the source code as private modules.
719 // The modules need to be private so that nobody actually uses them, but the
720 // keywords and primitives that they are documenting are public.
721 ItemKind::KeywordItem | ItemKind::PrimitiveItem(_) => return Some(Visibility::Public),
722 // Variant fields inherit their enum's visibility.
723 StructFieldItem(..) if is_field_vis_inherited(tcx, def_id) => {
726 // Variants always inherit visibility
727 VariantItem(..) => return None,
728 // Trait items inherit the trait's visibility
729 AssocConstItem(..) | TyAssocConstItem(..) | AssocTypeItem(..) | TyAssocTypeItem(..)
730 | TyMethodItem(..) | MethodItem(..) => {
731 let assoc_item = tcx.associated_item(def_id);
732 let is_trait_item = match assoc_item.container {
733 ty::TraitContainer => true,
734 ty::ImplContainer => {
735 // Trait impl items always inherit the impl's visibility --
736 // we don't want to show `pub`.
737 tcx.impl_trait_ref(tcx.parent(assoc_item.def_id)).is_some()
746 let def_id = match self.inline_stmt_id {
747 Some(inlined) => inlined,
750 Some(tcx.visibility(def_id))
754 #[derive(Clone, Debug)]
755 pub(crate) enum ItemKind {
757 /// The crate's name, *not* the name it's imported as.
764 FunctionItem(Box<Function>),
766 TypedefItem(Box<Typedef>),
767 OpaqueTyItem(OpaqueTy),
769 ConstantItem(Constant),
770 TraitItem(Box<Trait>),
771 TraitAliasItem(TraitAlias),
773 /// A required method in a trait declaration meaning it's only a function signature.
774 TyMethodItem(Box<Function>),
775 /// A method in a trait impl or a provided method in a trait declaration.
777 /// Compared to [TyMethodItem], it also contains a method body.
778 MethodItem(Box<Function>, Option<hir::Defaultness>),
779 StructFieldItem(Type),
780 VariantItem(Variant),
781 /// `fn`s from an extern block
782 ForeignFunctionItem(Box<Function>),
783 /// `static`s from an extern block
784 ForeignStaticItem(Static),
785 /// `type`s from an extern block
788 ProcMacroItem(ProcMacro),
789 PrimitiveItem(PrimitiveType),
790 /// A required associated constant in a trait declaration.
791 TyAssocConstItem(Type),
792 /// An associated associated constant in a trait impl or a provided one in a trait declaration.
793 AssocConstItem(Type, ConstantKind),
794 /// A required associated type in a trait declaration.
796 /// The bounds may be non-empty if there is a `where` clause.
797 TyAssocTypeItem(Generics, Vec<GenericBound>),
798 /// An associated type in a trait impl or a provided one in a trait declaration.
799 AssocTypeItem(Box<Typedef>, Vec<GenericBound>),
800 /// An item that has been stripped by a rustdoc pass
801 StrippedItem(Box<ItemKind>),
806 /// Some items contain others such as structs (for their fields) and Enums
807 /// (for their variants). This method returns those contained items.
808 pub(crate) fn inner_items(&self) -> impl Iterator<Item = &Item> {
810 StructItem(s) => s.fields.iter(),
811 UnionItem(u) => u.fields.iter(),
812 VariantItem(v) => match &v.kind {
813 VariantKind::CLike => [].iter(),
814 VariantKind::Tuple(t) => t.iter(),
815 VariantKind::Struct(s) => s.fields.iter(),
817 EnumItem(e) => e.variants.iter(),
818 TraitItem(t) => t.items.iter(),
819 ImplItem(i) => i.items.iter(),
820 ModuleItem(m) => m.items.iter(),
821 ExternCrateItem { .. }
832 | ForeignFunctionItem(_)
833 | ForeignStaticItem(_)
838 | TyAssocConstItem(_)
839 | AssocConstItem(_, _)
840 | TyAssocTypeItem(..)
843 | KeywordItem => [].iter(),
847 /// Returns `true` if this item does not appear inside an impl block.
848 pub(crate) fn is_non_assoc(&self) -> bool {
856 | ExternCrateItem { .. }
863 | ForeignFunctionItem(_)
864 | ForeignStaticItem(_)
873 #[derive(Clone, Debug)]
874 pub(crate) struct Module {
875 pub(crate) items: Vec<Item>,
876 pub(crate) span: Span,
879 pub(crate) trait AttributesExt {
880 type AttributeIterator<'a>: Iterator<Item = ast::NestedMetaItem>
884 fn lists<'a>(&'a self, name: Symbol) -> Self::AttributeIterator<'a>;
886 fn span(&self) -> Option<rustc_span::Span>;
888 fn inner_docs(&self) -> bool;
890 fn cfg(&self, tcx: TyCtxt<'_>, hidden_cfg: &FxHashSet<Cfg>) -> Option<Arc<Cfg>>;
893 impl AttributesExt for [ast::Attribute] {
894 type AttributeIterator<'a> = impl Iterator<Item = ast::NestedMetaItem> + 'a;
896 fn lists<'a>(&'a self, name: Symbol) -> Self::AttributeIterator<'a> {
898 .filter(move |attr| attr.has_name(name))
899 .filter_map(ast::Attribute::meta_item_list)
903 /// Return the span of the first doc-comment, if it exists.
904 fn span(&self) -> Option<rustc_span::Span> {
905 self.iter().find(|attr| attr.doc_str().is_some()).map(|attr| attr.span)
908 /// Returns whether the first doc-comment is an inner attribute.
910 //// If there are no doc-comments, return true.
911 /// FIXME(#78591): Support both inner and outer attributes on the same item.
912 fn inner_docs(&self) -> bool {
913 self.iter().find(|a| a.doc_str().is_some()).map_or(true, |a| a.style == AttrStyle::Inner)
916 fn cfg(&self, tcx: TyCtxt<'_>, hidden_cfg: &FxHashSet<Cfg>) -> Option<Arc<Cfg>> {
918 let doc_cfg_active = tcx.features().doc_cfg;
919 let doc_auto_cfg_active = tcx.features().doc_auto_cfg;
921 fn single<T: IntoIterator>(it: T) -> Option<T::Item> {
922 let mut iter = it.into_iter();
923 let item = iter.next()?;
924 if iter.next().is_some() {
930 let mut cfg = if doc_cfg_active || doc_auto_cfg_active {
931 let mut doc_cfg = self
933 .filter(|attr| attr.has_name(sym::doc))
934 .flat_map(|attr| attr.meta_item_list().unwrap_or_default())
935 .filter(|attr| attr.has_name(sym::cfg))
937 if doc_cfg.peek().is_some() && doc_cfg_active {
939 .filter_map(|attr| Cfg::parse(attr.meta_item()?).ok())
940 .fold(Cfg::True, |cfg, new_cfg| cfg & new_cfg)
941 } else if doc_auto_cfg_active {
943 .filter(|attr| attr.has_name(sym::cfg))
944 .filter_map(|attr| single(attr.meta_item_list()?))
946 Cfg::parse_without(attr.meta_item()?, hidden_cfg).ok().flatten()
948 .fold(Cfg::True, |cfg, new_cfg| cfg & new_cfg)
956 for attr in self.iter() {
958 if attr.doc_str().is_none() && attr.has_name(sym::doc) {
960 if let Some(list) = attr.meta().as_ref().and_then(|mi| mi.meta_item_list()) {
963 if !item.has_name(sym::cfg) {
967 if let Some(cfg_mi) = item
969 .and_then(|item| rustc_expand::config::parse_cfg(item, sess))
971 match Cfg::parse(cfg_mi) {
972 Ok(new_cfg) => cfg &= new_cfg,
974 sess.span_err(e.span, e.msg);
983 // treat #[target_feature(enable = "feat")] attributes as if they were
984 // #[doc(cfg(target_feature = "feat"))] attributes as well
985 for attr in self.lists(sym::target_feature) {
986 if attr.has_name(sym::enable) {
987 if attr.value_str().is_some() {
988 // Clone `enable = "feat"`, change to `target_feature = "feat"`.
989 // Unwrap is safe because `value_str` succeeded above.
990 let mut meta = attr.meta_item().unwrap().clone();
991 meta.path = ast::Path::from_ident(Ident::with_dummy_span(sym::target_feature));
993 if let Ok(feat_cfg) = Cfg::parse(&meta) {
1000 if cfg == Cfg::True { None } else { Some(Arc::new(cfg)) }
1004 pub(crate) trait NestedAttributesExt {
1005 /// Returns `true` if the attribute list contains a specific `word`
1006 fn has_word(self, word: Symbol) -> bool
1008 Self: std::marker::Sized,
1010 <Self as NestedAttributesExt>::get_word_attr(self, word).is_some()
1013 /// Returns `Some(attr)` if the attribute list contains 'attr'
1014 /// corresponding to a specific `word`
1015 fn get_word_attr(self, word: Symbol) -> Option<ast::NestedMetaItem>;
1018 impl<I: Iterator<Item = ast::NestedMetaItem>> NestedAttributesExt for I {
1019 fn get_word_attr(mut self, word: Symbol) -> Option<ast::NestedMetaItem> {
1020 self.find(|attr| attr.is_word() && attr.has_name(word))
1024 /// A portion of documentation, extracted from a `#[doc]` attribute.
1026 /// Each variant contains the line number within the complete doc-comment where the fragment
1027 /// starts, as well as the Span where the corresponding doc comment or attribute is located.
1029 /// Included files are kept separate from inline doc comments so that proper line-number
1030 /// information can be given when a doctest fails. Sugared doc comments and "raw" doc comments are
1031 /// kept separate because of issue #42760.
1032 #[derive(Clone, PartialEq, Eq, Debug)]
1033 pub(crate) struct DocFragment {
1034 pub(crate) span: rustc_span::Span,
1035 /// The module this doc-comment came from.
1037 /// This allows distinguishing between the original documentation and a pub re-export.
1038 /// If it is `None`, the item was not re-exported.
1039 pub(crate) parent_module: Option<DefId>,
1040 pub(crate) doc: Symbol,
1041 pub(crate) kind: DocFragmentKind,
1042 pub(crate) indent: usize,
1045 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
1046 pub(crate) enum DocFragmentKind {
1047 /// A doc fragment created from a `///` or `//!` doc comment.
1049 /// A doc fragment created from a "raw" `#[doc=""]` attribute.
1053 /// The goal of this function is to apply the `DocFragment` transformation that is required when
1054 /// transforming into the final Markdown, which is applying the computed indent to each line in
1055 /// each doc fragment (a `DocFragment` can contain multiple lines in case of `#[doc = ""]`).
1057 /// Note: remove the trailing newline where appropriate
1058 fn add_doc_fragment(out: &mut String, frag: &DocFragment) {
1059 let s = frag.doc.as_str();
1060 let mut iter = s.lines();
1065 while let Some(line) = iter.next() {
1066 if line.chars().any(|c| !c.is_whitespace()) {
1067 assert!(line.len() >= frag.indent);
1068 out.push_str(&line[frag.indent..]);
1076 /// Collapse a collection of [`DocFragment`]s into one string,
1077 /// handling indentation and newlines as needed.
1078 pub(crate) fn collapse_doc_fragments(doc_strings: &[DocFragment]) -> String {
1079 let mut acc = String::new();
1080 for frag in doc_strings {
1081 add_doc_fragment(&mut acc, frag);
1087 /// Removes excess indentation on comments in order for the Markdown
1088 /// to be parsed correctly. This is necessary because the convention for
1089 /// writing documentation is to provide a space between the /// or //! marker
1090 /// and the doc text, but Markdown is whitespace-sensitive. For example,
1091 /// a block of text with four-space indentation is parsed as a code block,
1092 /// so if we didn't unindent comments, these list items
1099 /// would be parsed as if they were in a code block, which is likely not what the user intended.
1100 fn unindent_doc_fragments(docs: &mut Vec<DocFragment>) {
1101 // `add` is used in case the most common sugared doc syntax is used ("/// "). The other
1102 // fragments kind's lines are never starting with a whitespace unless they are using some
1103 // markdown formatting requiring it. Therefore, if the doc block have a mix between the two,
1104 // we need to take into account the fact that the minimum indent minus one (to take this
1105 // whitespace into account).
1110 // #[doc = "another"]
1112 // In this case, you want "hello! another" and not "hello! another".
1113 let add = if docs.windows(2).any(|arr| arr[0].kind != arr[1].kind)
1114 && docs.iter().any(|d| d.kind == DocFragmentKind::SugaredDoc)
1116 // In case we have a mix of sugared doc comments and "raw" ones, we want the sugared one to
1117 // "decide" how much the minimum indent will be.
1123 // `min_indent` is used to know how much whitespaces from the start of each lines must be
1124 // removed. Example:
1127 // #[doc = "another"]
1129 // In here, the `min_indent` is 1 (because non-sugared fragment are always counted with minimum
1130 // 1 whitespace), meaning that "hello!" will be considered a codeblock because it starts with 4
1131 // (5 - 1) whitespaces.
1132 let Some(min_indent) = docs
1135 fragment.doc.as_str().lines().fold(usize::MAX, |min_indent, line| {
1136 if line.chars().all(|c| c.is_whitespace()) {
1139 // Compare against either space or tab, ignoring whether they are
1141 let whitespace = line.chars().take_while(|c| *c == ' ' || *c == '\t').count();
1142 cmp::min(min_indent, whitespace)
1143 + if fragment.kind == DocFragmentKind::SugaredDoc { 0 } else { add }
1152 for fragment in docs {
1153 if fragment.doc == kw::Empty {
1157 let min_indent = if fragment.kind != DocFragmentKind::SugaredDoc && min_indent > 0 {
1163 fragment.indent = min_indent;
1167 /// A link that has not yet been rendered.
1169 /// This link will be turned into a rendered link by [`Item::links`].
1170 #[derive(Clone, Debug, PartialEq, Eq)]
1171 pub(crate) struct ItemLink {
1172 /// The original link written in the markdown
1173 pub(crate) link: String,
1174 /// The link text displayed in the HTML.
1176 /// This may not be the same as `link` if there was a disambiguator
1177 /// in an intra-doc link (e.g. \[`fn@f`\])
1178 pub(crate) link_text: String,
1179 /// The `DefId` of the Item whose **HTML Page** contains the item being
1180 /// linked to. This will be different to `item_id` on item's that don't
1181 /// have their own page, such as struct fields and enum variants.
1182 pub(crate) page_id: DefId,
1183 /// The url fragment to append to the link
1184 pub(crate) fragment: Option<UrlFragment>,
1187 pub struct RenderedLink {
1188 /// The text the link was original written as.
1190 /// This could potentially include disambiguators and backticks.
1191 pub(crate) original_text: String,
1192 /// The text to display in the HTML
1193 pub(crate) new_text: String,
1194 /// The URL to put in the `href`
1195 pub(crate) href: String,
1198 /// The attributes on an [`Item`], including attributes like `#[derive(...)]` and `#[inline]`,
1199 /// as well as doc comments.
1200 #[derive(Clone, Debug, Default)]
1201 pub(crate) struct Attributes {
1202 pub(crate) doc_strings: Vec<DocFragment>,
1203 pub(crate) other_attrs: ast::AttrVec,
1207 pub(crate) fn lists(&self, name: Symbol) -> impl Iterator<Item = ast::NestedMetaItem> + '_ {
1208 self.other_attrs.lists(name)
1211 pub(crate) fn has_doc_flag(&self, flag: Symbol) -> bool {
1212 for attr in &self.other_attrs {
1213 if !attr.has_name(sym::doc) {
1217 if let Some(items) = attr.meta_item_list() {
1218 if items.iter().filter_map(|i| i.meta_item()).any(|it| it.has_name(flag)) {
1227 pub(crate) fn from_ast(attrs: &[ast::Attribute]) -> Attributes {
1228 Attributes::from_ast_iter(attrs.iter().map(|attr| (attr, None)), false)
1231 pub(crate) fn from_ast_with_additional(
1232 attrs: &[ast::Attribute],
1233 (additional_attrs, def_id): (&[ast::Attribute], DefId),
1235 // Additional documentation should be shown before the original documentation.
1236 let attrs1 = additional_attrs.iter().map(|attr| (attr, Some(def_id)));
1237 let attrs2 = attrs.iter().map(|attr| (attr, None));
1238 Attributes::from_ast_iter(attrs1.chain(attrs2), false)
1241 pub(crate) fn from_ast_iter<'a>(
1242 attrs: impl Iterator<Item = (&'a ast::Attribute, Option<DefId>)>,
1245 let mut doc_strings = Vec::new();
1246 let mut other_attrs = ast::AttrVec::new();
1247 for (attr, parent_module) in attrs {
1248 if let Some((doc_str, comment_kind)) = attr.doc_str_and_comment_kind() {
1249 trace!("got doc_str={doc_str:?}");
1250 let doc = beautify_doc_string(doc_str, comment_kind);
1251 let kind = if attr.is_doc_comment() {
1252 DocFragmentKind::SugaredDoc
1254 DocFragmentKind::RawDoc
1256 let fragment = DocFragment { span: attr.span, doc, kind, parent_module, indent: 0 };
1257 doc_strings.push(fragment);
1258 } else if !doc_only {
1259 other_attrs.push(attr.clone());
1263 unindent_doc_fragments(&mut doc_strings);
1265 Attributes { doc_strings, other_attrs }
1268 /// Finds the `doc` attribute as a NameValue and returns the corresponding
1270 pub(crate) fn doc_value(&self) -> Option<String> {
1271 let mut iter = self.doc_strings.iter();
1273 let ori = iter.next()?;
1274 let mut out = String::new();
1275 add_doc_fragment(&mut out, ori);
1276 for new_frag in iter {
1277 add_doc_fragment(&mut out, new_frag);
1280 if out.is_empty() { None } else { Some(out) }
1283 /// Return the doc-comments on this item, grouped by the module they came from.
1284 /// The module can be different if this is a re-export with added documentation.
1286 /// The last newline is not trimmed so the produced strings are reusable between
1287 /// early and late doc link resolution regardless of their position.
1288 pub(crate) fn prepare_to_doc_link_resolution(&self) -> FxHashMap<Option<DefId>, String> {
1289 let mut res = FxHashMap::default();
1290 for fragment in &self.doc_strings {
1291 let out_str = res.entry(fragment.parent_module).or_default();
1292 add_doc_fragment(out_str, fragment);
1297 /// Finds all `doc` attributes as NameValues and returns their corresponding values, joined
1299 pub(crate) fn collapsed_doc_value(&self) -> Option<String> {
1300 if self.doc_strings.is_empty() {
1303 Some(collapse_doc_fragments(&self.doc_strings))
1307 pub(crate) fn get_doc_aliases(&self) -> Box<[Symbol]> {
1308 let mut aliases = FxHashSet::default();
1310 for attr in self.other_attrs.lists(sym::doc).filter(|a| a.has_name(sym::alias)) {
1311 if let Some(values) = attr.meta_item_list() {
1313 match l.lit().unwrap().kind {
1314 ast::LitKind::Str(s, _) => {
1317 _ => unreachable!(),
1321 aliases.insert(attr.value_str().unwrap());
1324 aliases.into_iter().collect::<Vec<_>>().into()
1328 impl PartialEq for Attributes {
1329 fn eq(&self, rhs: &Self) -> bool {
1330 self.doc_strings == rhs.doc_strings
1334 .map(|attr| attr.id)
1335 .eq(rhs.other_attrs.iter().map(|attr| attr.id))
1339 impl Eq for Attributes {}
1341 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1342 pub(crate) enum GenericBound {
1343 TraitBound(PolyTrait, hir::TraitBoundModifier),
1348 pub(crate) fn maybe_sized(cx: &mut DocContext<'_>) -> GenericBound {
1349 let did = cx.tcx.require_lang_item(LangItem::Sized, None);
1350 let empty = ty::Binder::dummy(ty::InternalSubsts::empty());
1351 let path = external_path(cx, did, false, ThinVec::new(), empty);
1352 inline::record_extern_fqn(cx, did, ItemType::Trait);
1353 GenericBound::TraitBound(
1354 PolyTrait { trait_: path, generic_params: Vec::new() },
1355 hir::TraitBoundModifier::Maybe,
1359 pub(crate) fn is_sized_bound(&self, cx: &DocContext<'_>) -> bool {
1360 use rustc_hir::TraitBoundModifier as TBM;
1361 if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, TBM::None) = *self {
1362 if Some(trait_.def_id()) == cx.tcx.lang_items().sized_trait() {
1369 pub(crate) fn get_poly_trait(&self) -> Option<PolyTrait> {
1370 if let GenericBound::TraitBound(ref p, _) = *self {
1371 return Some(p.clone());
1376 pub(crate) fn get_trait_path(&self) -> Option<Path> {
1377 if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, _) = *self {
1378 Some(trait_.clone())
1385 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1386 pub(crate) struct Lifetime(pub Symbol);
1389 pub(crate) fn statik() -> Lifetime {
1390 Lifetime(kw::StaticLifetime)
1393 pub(crate) fn elided() -> Lifetime {
1394 Lifetime(kw::UnderscoreLifetime)
1398 #[derive(Clone, Debug)]
1399 pub(crate) enum WherePredicate {
1400 BoundPredicate { ty: Type, bounds: Vec<GenericBound>, bound_params: Vec<Lifetime> },
1401 RegionPredicate { lifetime: Lifetime, bounds: Vec<GenericBound> },
1402 EqPredicate { lhs: Box<Type>, rhs: Box<Term>, bound_params: Vec<Lifetime> },
1405 impl WherePredicate {
1406 pub(crate) fn get_bounds(&self) -> Option<&[GenericBound]> {
1408 WherePredicate::BoundPredicate { ref bounds, .. } => Some(bounds),
1409 WherePredicate::RegionPredicate { ref bounds, .. } => Some(bounds),
1414 pub(crate) fn get_bound_params(&self) -> Option<&[Lifetime]> {
1416 Self::BoundPredicate { bound_params, .. } | Self::EqPredicate { bound_params, .. } => {
1424 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1425 pub(crate) enum GenericParamDefKind {
1426 Lifetime { outlives: Vec<Lifetime> },
1427 Type { did: DefId, bounds: Vec<GenericBound>, default: Option<Box<Type>>, synthetic: bool },
1428 Const { did: DefId, ty: Box<Type>, default: Option<Box<String>> },
1431 impl GenericParamDefKind {
1432 pub(crate) fn is_type(&self) -> bool {
1433 matches!(self, GenericParamDefKind::Type { .. })
1437 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1438 pub(crate) struct GenericParamDef {
1439 pub(crate) name: Symbol,
1440 pub(crate) kind: GenericParamDefKind,
1443 impl GenericParamDef {
1444 pub(crate) fn lifetime(name: Symbol) -> Self {
1445 Self { name, kind: GenericParamDefKind::Lifetime { outlives: Vec::new() } }
1448 pub(crate) fn is_synthetic_type_param(&self) -> bool {
1450 GenericParamDefKind::Lifetime { .. } | GenericParamDefKind::Const { .. } => false,
1451 GenericParamDefKind::Type { synthetic, .. } => synthetic,
1455 pub(crate) fn is_type(&self) -> bool {
1459 pub(crate) fn get_bounds(&self) -> Option<&[GenericBound]> {
1461 GenericParamDefKind::Type { ref bounds, .. } => Some(bounds),
1467 // maybe use a Generic enum and use Vec<Generic>?
1468 #[derive(Clone, Debug, Default)]
1469 pub(crate) struct Generics {
1470 pub(crate) params: ThinVec<GenericParamDef>,
1471 pub(crate) where_predicates: ThinVec<WherePredicate>,
1475 pub(crate) fn is_empty(&self) -> bool {
1476 self.params.is_empty() && self.where_predicates.is_empty()
1480 #[derive(Clone, Debug)]
1481 pub(crate) struct Function {
1482 pub(crate) decl: FnDecl,
1483 pub(crate) generics: Generics,
1486 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1487 pub(crate) struct FnDecl {
1488 pub(crate) inputs: Arguments,
1489 pub(crate) output: FnRetTy,
1490 pub(crate) c_variadic: bool,
1494 pub(crate) fn self_type(&self) -> Option<SelfTy> {
1495 self.inputs.values.get(0).and_then(|v| v.to_self())
1498 /// Returns the sugared return type for an async function.
1500 /// For example, if the return type is `impl std::future::Future<Output = i32>`, this function
1501 /// will return `i32`.
1505 /// This function will panic if the return type does not match the expected sugaring for async
1507 pub(crate) fn sugared_async_return_type(&self) -> FnRetTy {
1508 match &self.output {
1509 FnRetTy::Return(Type::ImplTrait(bounds)) => match &bounds[0] {
1510 GenericBound::TraitBound(PolyTrait { trait_, .. }, ..) => {
1511 let bindings = trait_.bindings().unwrap();
1512 let ret_ty = bindings[0].term();
1513 let ty = ret_ty.ty().expect("Unexpected constant return term");
1514 FnRetTy::Return(ty.clone())
1516 _ => panic!("unexpected desugaring of async function"),
1518 _ => panic!("unexpected desugaring of async function"),
1523 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1524 pub(crate) struct Arguments {
1525 pub(crate) values: Vec<Argument>,
1528 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1529 pub(crate) struct Argument {
1530 pub(crate) type_: Type,
1531 pub(crate) name: Symbol,
1532 /// This field is used to represent "const" arguments from the `rustc_legacy_const_generics`
1533 /// feature. More information in <https://github.com/rust-lang/rust/issues/83167>.
1534 pub(crate) is_const: bool,
1537 #[derive(Clone, PartialEq, Debug)]
1538 pub(crate) enum SelfTy {
1540 SelfBorrowed(Option<Lifetime>, Mutability),
1545 pub(crate) fn to_self(&self) -> Option<SelfTy> {
1546 if self.name != kw::SelfLower {
1549 if self.type_.is_self_type() {
1550 return Some(SelfValue);
1553 BorrowedRef { ref lifetime, mutability, ref type_ } if type_.is_self_type() => {
1554 Some(SelfBorrowed(lifetime.clone(), mutability))
1556 _ => Some(SelfExplicit(self.type_.clone())),
1561 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1562 pub(crate) enum FnRetTy {
1568 pub(crate) fn as_return(&self) -> Option<&Type> {
1570 Return(ret) => Some(ret),
1571 DefaultReturn => None,
1576 #[derive(Clone, Debug)]
1577 pub(crate) struct Trait {
1578 pub(crate) def_id: DefId,
1579 pub(crate) items: Vec<Item>,
1580 pub(crate) generics: Generics,
1581 pub(crate) bounds: Vec<GenericBound>,
1585 pub(crate) fn is_auto(&self, tcx: TyCtxt<'_>) -> bool {
1586 tcx.trait_is_auto(self.def_id)
1588 pub(crate) fn is_notable_trait(&self, tcx: TyCtxt<'_>) -> bool {
1589 tcx.is_doc_notable_trait(self.def_id)
1591 pub(crate) fn unsafety(&self, tcx: TyCtxt<'_>) -> hir::Unsafety {
1592 tcx.trait_def(self.def_id).unsafety
1596 #[derive(Clone, Debug)]
1597 pub(crate) struct TraitAlias {
1598 pub(crate) generics: Generics,
1599 pub(crate) bounds: Vec<GenericBound>,
1602 /// A trait reference, which may have higher ranked lifetimes.
1603 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1604 pub(crate) struct PolyTrait {
1605 pub(crate) trait_: Path,
1606 pub(crate) generic_params: Vec<GenericParamDef>,
1609 /// Rustdoc's representation of types, mostly based on the [`hir::Ty`].
1610 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1611 pub(crate) enum Type {
1612 /// A named type, which could be a trait.
1614 /// This is mostly Rustdoc's version of [`hir::Path`].
1615 /// It has to be different because Rustdoc's [`PathSegment`] can contain cleaned generics.
1616 Path { path: Path },
1617 /// A `dyn Trait` object: `dyn for<'a> Trait<'a> + Send + 'static`
1618 DynTrait(Vec<PolyTrait>, Option<Lifetime>),
1619 /// A type parameter.
1621 /// A primitive (aka, builtin) type.
1622 Primitive(PrimitiveType),
1623 /// A function pointer: `extern "ABI" fn(...) -> ...`
1624 BareFunction(Box<BareFunctionDecl>),
1625 /// A tuple type: `(i32, &str)`.
1627 /// A slice type (does *not* include the `&`): `[i32]`
1631 /// The `String` field is a stringified version of the array's length parameter.
1632 Array(Box<Type>, Box<str>),
1633 /// A raw pointer type: `*const i32`, `*mut i32`
1634 RawPointer(Mutability, Box<Type>),
1635 /// A reference type: `&i32`, `&'a mut Foo`
1636 BorrowedRef { lifetime: Option<Lifetime>, mutability: Mutability, type_: Box<Type> },
1638 /// A qualified path to an associated item: `<Type as Trait>::Name`
1639 QPath(Box<QPathData>),
1641 /// A type that is inferred: `_`
1644 /// An `impl Trait`: `impl TraitA + TraitB + ...`
1645 ImplTrait(Vec<GenericBound>),
1649 /// When comparing types for equality, it can help to ignore `&` wrapping.
1650 pub(crate) fn without_borrowed_ref(&self) -> &Type {
1651 let mut result = self;
1652 while let Type::BorrowedRef { type_, .. } = result {
1658 /// Check if two types are "potentially the same".
1659 /// This is different from `Eq`, because it knows that things like
1660 /// `Placeholder` are possible matches for everything.
1661 pub(crate) fn is_same(&self, other: &Self, cache: &Cache) -> bool {
1662 match (self, other) {
1664 (Type::Tuple(a), Type::Tuple(b)) => {
1665 a.len() == b.len() && a.iter().zip(b).all(|(a, b)| a.is_same(b, cache))
1667 (Type::Slice(a), Type::Slice(b)) => a.is_same(b, cache),
1668 (Type::Array(a, al), Type::Array(b, bl)) => al == bl && a.is_same(b, cache),
1669 (Type::RawPointer(mutability, type_), Type::RawPointer(b_mutability, b_type_)) => {
1670 mutability == b_mutability && type_.is_same(b_type_, cache)
1673 Type::BorrowedRef { mutability, type_, .. },
1674 Type::BorrowedRef { mutability: b_mutability, type_: b_type_, .. },
1675 ) => mutability == b_mutability && type_.is_same(b_type_, cache),
1676 // Placeholders and generics are equal to all other types.
1677 (Type::Infer, _) | (_, Type::Infer) => true,
1678 (Type::Generic(_), _) | (_, Type::Generic(_)) => true,
1679 // Other cases, such as primitives, just use recursion.
1682 .and_then(|a| Some((a, b.def_id(cache)?)))
1683 .map(|(a, b)| a == b)
1688 pub(crate) fn primitive_type(&self) -> Option<PrimitiveType> {
1690 Primitive(p) | BorrowedRef { type_: box Primitive(p), .. } => Some(p),
1691 Slice(..) | BorrowedRef { type_: box Slice(..), .. } => Some(PrimitiveType::Slice),
1692 Array(..) | BorrowedRef { type_: box Array(..), .. } => Some(PrimitiveType::Array),
1695 Some(PrimitiveType::Unit)
1697 Some(PrimitiveType::Tuple)
1700 RawPointer(..) => Some(PrimitiveType::RawPointer),
1701 BareFunction(..) => Some(PrimitiveType::Fn),
1706 /// Checks if this is a `T::Name` path for an associated type.
1707 pub(crate) fn is_assoc_ty(&self) -> bool {
1709 Type::Path { path, .. } => path.is_assoc_ty(),
1714 pub(crate) fn is_self_type(&self) -> bool {
1716 Generic(name) => name == kw::SelfUpper,
1721 pub(crate) fn generics(&self) -> Option<Vec<&Type>> {
1723 Type::Path { path, .. } => path.generics(),
1728 pub(crate) fn is_full_generic(&self) -> bool {
1729 matches!(self, Type::Generic(_))
1732 pub(crate) fn is_impl_trait(&self) -> bool {
1733 matches!(self, Type::ImplTrait(_))
1736 pub(crate) fn projection(&self) -> Option<(&Type, DefId, PathSegment)> {
1737 if let QPath(box QPathData { self_type, trait_, assoc, .. }) = self {
1738 Some((self_type, trait_.def_id(), assoc.clone()))
1744 fn inner_def_id(&self, cache: Option<&Cache>) -> Option<DefId> {
1745 let t: PrimitiveType = match *self {
1746 Type::Path { ref path } => return Some(path.def_id()),
1747 DynTrait(ref bounds, _) => return bounds.get(0).map(|b| b.trait_.def_id()),
1748 Primitive(p) => return cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
1749 BorrowedRef { type_: box Generic(..), .. } => PrimitiveType::Reference,
1750 BorrowedRef { ref type_, .. } => return type_.inner_def_id(cache),
1755 PrimitiveType::Tuple
1758 BareFunction(..) => PrimitiveType::Fn,
1759 Slice(..) => PrimitiveType::Slice,
1760 Array(..) => PrimitiveType::Array,
1761 RawPointer(..) => PrimitiveType::RawPointer,
1762 QPath(box QPathData { ref self_type, .. }) => return self_type.inner_def_id(cache),
1763 Generic(_) | Infer | ImplTrait(_) => return None,
1765 cache.and_then(|c| Primitive(t).def_id(c))
1768 /// Use this method to get the [DefId] of a [clean] AST node, including [PrimitiveType]s.
1770 /// [clean]: crate::clean
1771 pub(crate) fn def_id(&self, cache: &Cache) -> Option<DefId> {
1772 self.inner_def_id(Some(cache))
1776 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1777 pub(crate) struct QPathData {
1778 pub assoc: PathSegment,
1779 pub self_type: Type,
1780 /// FIXME: compute this field on demand.
1781 pub should_show_cast: bool,
1785 /// A primitive (aka, builtin) type.
1787 /// This represents things like `i32`, `str`, etc.
1789 /// N.B. This has to be different from [`hir::PrimTy`] because it also includes types that aren't
1790 /// paths, like [`Self::Unit`].
1791 #[derive(Clone, PartialEq, Eq, Hash, Copy, Debug)]
1792 pub(crate) enum PrimitiveType {
1820 type SimplifiedTypes = FxHashMap<PrimitiveType, ArrayVec<SimplifiedType, 3>>;
1821 impl PrimitiveType {
1822 pub(crate) fn from_hir(prim: hir::PrimTy) -> PrimitiveType {
1823 use ast::{FloatTy, IntTy, UintTy};
1825 hir::PrimTy::Int(IntTy::Isize) => PrimitiveType::Isize,
1826 hir::PrimTy::Int(IntTy::I8) => PrimitiveType::I8,
1827 hir::PrimTy::Int(IntTy::I16) => PrimitiveType::I16,
1828 hir::PrimTy::Int(IntTy::I32) => PrimitiveType::I32,
1829 hir::PrimTy::Int(IntTy::I64) => PrimitiveType::I64,
1830 hir::PrimTy::Int(IntTy::I128) => PrimitiveType::I128,
1831 hir::PrimTy::Uint(UintTy::Usize) => PrimitiveType::Usize,
1832 hir::PrimTy::Uint(UintTy::U8) => PrimitiveType::U8,
1833 hir::PrimTy::Uint(UintTy::U16) => PrimitiveType::U16,
1834 hir::PrimTy::Uint(UintTy::U32) => PrimitiveType::U32,
1835 hir::PrimTy::Uint(UintTy::U64) => PrimitiveType::U64,
1836 hir::PrimTy::Uint(UintTy::U128) => PrimitiveType::U128,
1837 hir::PrimTy::Float(FloatTy::F32) => PrimitiveType::F32,
1838 hir::PrimTy::Float(FloatTy::F64) => PrimitiveType::F64,
1839 hir::PrimTy::Str => PrimitiveType::Str,
1840 hir::PrimTy::Bool => PrimitiveType::Bool,
1841 hir::PrimTy::Char => PrimitiveType::Char,
1845 pub(crate) fn from_symbol(s: Symbol) -> Option<PrimitiveType> {
1847 sym::isize => Some(PrimitiveType::Isize),
1848 sym::i8 => Some(PrimitiveType::I8),
1849 sym::i16 => Some(PrimitiveType::I16),
1850 sym::i32 => Some(PrimitiveType::I32),
1851 sym::i64 => Some(PrimitiveType::I64),
1852 sym::i128 => Some(PrimitiveType::I128),
1853 sym::usize => Some(PrimitiveType::Usize),
1854 sym::u8 => Some(PrimitiveType::U8),
1855 sym::u16 => Some(PrimitiveType::U16),
1856 sym::u32 => Some(PrimitiveType::U32),
1857 sym::u64 => Some(PrimitiveType::U64),
1858 sym::u128 => Some(PrimitiveType::U128),
1859 sym::bool => Some(PrimitiveType::Bool),
1860 sym::char => Some(PrimitiveType::Char),
1861 sym::str => Some(PrimitiveType::Str),
1862 sym::f32 => Some(PrimitiveType::F32),
1863 sym::f64 => Some(PrimitiveType::F64),
1864 sym::array => Some(PrimitiveType::Array),
1865 sym::slice => Some(PrimitiveType::Slice),
1866 sym::tuple => Some(PrimitiveType::Tuple),
1867 sym::unit => Some(PrimitiveType::Unit),
1868 sym::pointer => Some(PrimitiveType::RawPointer),
1869 sym::reference => Some(PrimitiveType::Reference),
1870 kw::Fn => Some(PrimitiveType::Fn),
1871 sym::never => Some(PrimitiveType::Never),
1876 pub(crate) fn simplified_types() -> &'static SimplifiedTypes {
1877 use ty::fast_reject::SimplifiedType::*;
1878 use ty::{FloatTy, IntTy, UintTy};
1879 use PrimitiveType::*;
1880 static CELL: OnceCell<SimplifiedTypes> = OnceCell::new();
1882 let single = |x| iter::once(x).collect();
1883 CELL.get_or_init(move || {
1885 Isize => single(IntSimplifiedType(IntTy::Isize)),
1886 I8 => single(IntSimplifiedType(IntTy::I8)),
1887 I16 => single(IntSimplifiedType(IntTy::I16)),
1888 I32 => single(IntSimplifiedType(IntTy::I32)),
1889 I64 => single(IntSimplifiedType(IntTy::I64)),
1890 I128 => single(IntSimplifiedType(IntTy::I128)),
1891 Usize => single(UintSimplifiedType(UintTy::Usize)),
1892 U8 => single(UintSimplifiedType(UintTy::U8)),
1893 U16 => single(UintSimplifiedType(UintTy::U16)),
1894 U32 => single(UintSimplifiedType(UintTy::U32)),
1895 U64 => single(UintSimplifiedType(UintTy::U64)),
1896 U128 => single(UintSimplifiedType(UintTy::U128)),
1897 F32 => single(FloatSimplifiedType(FloatTy::F32)),
1898 F64 => single(FloatSimplifiedType(FloatTy::F64)),
1899 Str => single(StrSimplifiedType),
1900 Bool => single(BoolSimplifiedType),
1901 Char => single(CharSimplifiedType),
1902 Array => single(ArraySimplifiedType),
1903 Slice => single(SliceSimplifiedType),
1904 // FIXME: If we ever add an inherent impl for tuples
1905 // with different lengths, they won't show in rustdoc.
1907 // Either manually update this arrayvec at this point
1908 // or start with a more complex refactoring.
1909 Tuple => [TupleSimplifiedType(1), TupleSimplifiedType(2), TupleSimplifiedType(3)].into(),
1910 Unit => single(TupleSimplifiedType(0)),
1911 RawPointer => [PtrSimplifiedType(Mutability::Not), PtrSimplifiedType(Mutability::Mut)].into_iter().collect(),
1912 Reference => [RefSimplifiedType(Mutability::Not), RefSimplifiedType(Mutability::Mut)].into_iter().collect(),
1913 // FIXME: This will be wrong if we ever add inherent impls
1914 // for function pointers.
1915 Fn => single(FunctionSimplifiedType(1)),
1916 Never => single(NeverSimplifiedType),
1921 pub(crate) fn impls<'tcx>(&self, tcx: TyCtxt<'tcx>) -> impl Iterator<Item = DefId> + 'tcx {
1922 Self::simplified_types()
1926 .flat_map(move |&simp| tcx.incoherent_impls(simp))
1930 pub(crate) fn all_impls(tcx: TyCtxt<'_>) -> impl Iterator<Item = DefId> + '_ {
1931 Self::simplified_types()
1934 .flat_map(move |&simp| tcx.incoherent_impls(simp))
1938 pub(crate) fn as_sym(&self) -> Symbol {
1939 use PrimitiveType::*;
1941 Isize => sym::isize,
1947 Usize => sym::usize,
1958 Array => sym::array,
1959 Slice => sym::slice,
1960 Tuple => sym::tuple,
1962 RawPointer => sym::pointer,
1963 Reference => sym::reference,
1965 Never => sym::never,
1969 /// Returns the DefId of the module with `doc(primitive)` for this primitive type.
1970 /// Panics if there is no such module.
1972 /// This gives precedence to primitives defined in the current crate, and deprioritizes primitives defined in `core`,
1973 /// but otherwise, if multiple crates define the same primitive, there is no guarantee of which will be picked.
1974 /// In particular, if a crate depends on both `std` and another crate that also defines `doc(primitive)`, then
1975 /// it's entirely random whether `std` or the other crate is picked. (no_std crates are usually fine unless multiple dependencies define a primitive.)
1976 pub(crate) fn primitive_locations(tcx: TyCtxt<'_>) -> &FxHashMap<PrimitiveType, DefId> {
1977 static PRIMITIVE_LOCATIONS: OnceCell<FxHashMap<PrimitiveType, DefId>> = OnceCell::new();
1978 PRIMITIVE_LOCATIONS.get_or_init(|| {
1979 let mut primitive_locations = FxHashMap::default();
1980 // NOTE: technically this misses crates that are only passed with `--extern` and not loaded when checking the crate.
1981 // This is a degenerate case that I don't plan to support.
1982 for &crate_num in tcx.crates(()) {
1983 let e = ExternalCrate { crate_num };
1984 let crate_name = e.name(tcx);
1985 debug!(?crate_num, ?crate_name);
1986 for &(def_id, prim) in &e.primitives(tcx) {
1987 // HACK: try to link to std instead where possible
1988 if crate_name == sym::core && primitive_locations.contains_key(&prim) {
1991 primitive_locations.insert(prim, def_id);
1994 let local_primitives = ExternalCrate { crate_num: LOCAL_CRATE }.primitives(tcx);
1995 for (def_id, prim) in local_primitives {
1996 primitive_locations.insert(prim, def_id);
2003 impl From<ast::IntTy> for PrimitiveType {
2004 fn from(int_ty: ast::IntTy) -> PrimitiveType {
2006 ast::IntTy::Isize => PrimitiveType::Isize,
2007 ast::IntTy::I8 => PrimitiveType::I8,
2008 ast::IntTy::I16 => PrimitiveType::I16,
2009 ast::IntTy::I32 => PrimitiveType::I32,
2010 ast::IntTy::I64 => PrimitiveType::I64,
2011 ast::IntTy::I128 => PrimitiveType::I128,
2016 impl From<ast::UintTy> for PrimitiveType {
2017 fn from(uint_ty: ast::UintTy) -> PrimitiveType {
2019 ast::UintTy::Usize => PrimitiveType::Usize,
2020 ast::UintTy::U8 => PrimitiveType::U8,
2021 ast::UintTy::U16 => PrimitiveType::U16,
2022 ast::UintTy::U32 => PrimitiveType::U32,
2023 ast::UintTy::U64 => PrimitiveType::U64,
2024 ast::UintTy::U128 => PrimitiveType::U128,
2029 impl From<ast::FloatTy> for PrimitiveType {
2030 fn from(float_ty: ast::FloatTy) -> PrimitiveType {
2032 ast::FloatTy::F32 => PrimitiveType::F32,
2033 ast::FloatTy::F64 => PrimitiveType::F64,
2038 impl From<ty::IntTy> for PrimitiveType {
2039 fn from(int_ty: ty::IntTy) -> PrimitiveType {
2041 ty::IntTy::Isize => PrimitiveType::Isize,
2042 ty::IntTy::I8 => PrimitiveType::I8,
2043 ty::IntTy::I16 => PrimitiveType::I16,
2044 ty::IntTy::I32 => PrimitiveType::I32,
2045 ty::IntTy::I64 => PrimitiveType::I64,
2046 ty::IntTy::I128 => PrimitiveType::I128,
2051 impl From<ty::UintTy> for PrimitiveType {
2052 fn from(uint_ty: ty::UintTy) -> PrimitiveType {
2054 ty::UintTy::Usize => PrimitiveType::Usize,
2055 ty::UintTy::U8 => PrimitiveType::U8,
2056 ty::UintTy::U16 => PrimitiveType::U16,
2057 ty::UintTy::U32 => PrimitiveType::U32,
2058 ty::UintTy::U64 => PrimitiveType::U64,
2059 ty::UintTy::U128 => PrimitiveType::U128,
2064 impl From<ty::FloatTy> for PrimitiveType {
2065 fn from(float_ty: ty::FloatTy) -> PrimitiveType {
2067 ty::FloatTy::F32 => PrimitiveType::F32,
2068 ty::FloatTy::F64 => PrimitiveType::F64,
2073 impl From<hir::PrimTy> for PrimitiveType {
2074 fn from(prim_ty: hir::PrimTy) -> PrimitiveType {
2076 hir::PrimTy::Int(int_ty) => int_ty.into(),
2077 hir::PrimTy::Uint(uint_ty) => uint_ty.into(),
2078 hir::PrimTy::Float(float_ty) => float_ty.into(),
2079 hir::PrimTy::Str => PrimitiveType::Str,
2080 hir::PrimTy::Bool => PrimitiveType::Bool,
2081 hir::PrimTy::Char => PrimitiveType::Char,
2086 #[derive(Clone, Debug)]
2087 pub(crate) struct Struct {
2088 pub(crate) ctor_kind: Option<CtorKind>,
2089 pub(crate) generics: Generics,
2090 pub(crate) fields: Vec<Item>,
2094 pub(crate) fn has_stripped_entries(&self) -> bool {
2095 self.fields.iter().any(|f| f.is_stripped())
2099 #[derive(Clone, Debug)]
2100 pub(crate) struct Union {
2101 pub(crate) generics: Generics,
2102 pub(crate) fields: Vec<Item>,
2106 pub(crate) fn has_stripped_entries(&self) -> bool {
2107 self.fields.iter().any(|f| f.is_stripped())
2111 /// This is a more limited form of the standard Struct, different in that
2112 /// it lacks the things most items have (name, id, parameterization). Found
2113 /// only as a variant in an enum.
2114 #[derive(Clone, Debug)]
2115 pub(crate) struct VariantStruct {
2116 pub(crate) fields: Vec<Item>,
2119 impl VariantStruct {
2120 pub(crate) fn has_stripped_entries(&self) -> bool {
2121 self.fields.iter().any(|f| f.is_stripped())
2125 #[derive(Clone, Debug)]
2126 pub(crate) struct Enum {
2127 pub(crate) variants: IndexVec<VariantIdx, Item>,
2128 pub(crate) generics: Generics,
2132 pub(crate) fn has_stripped_entries(&self) -> bool {
2133 self.variants.iter().any(|f| f.is_stripped())
2136 pub(crate) fn variants(&self) -> impl Iterator<Item = &Item> {
2137 self.variants.iter().filter(|v| !v.is_stripped())
2141 #[derive(Clone, Debug)]
2142 pub(crate) struct Variant {
2143 pub kind: VariantKind,
2144 pub discriminant: Option<Discriminant>,
2147 #[derive(Clone, Debug)]
2148 pub(crate) enum VariantKind {
2151 Struct(VariantStruct),
2155 pub(crate) fn has_stripped_entries(&self) -> Option<bool> {
2157 VariantKind::Struct(struct_) => Some(struct_.has_stripped_entries()),
2158 VariantKind::CLike | VariantKind::Tuple(_) => None,
2163 #[derive(Clone, Debug)]
2164 pub(crate) struct Discriminant {
2165 // In the case of cross crate re-exports, we don't have the nessesary information
2166 // to reconstruct the expression of the discriminant, only the value.
2167 pub(super) expr: Option<BodyId>,
2168 pub(super) value: DefId,
2172 /// Will be `None` in the case of cross-crate reexports, and may be
2174 pub(crate) fn expr(&self, tcx: TyCtxt<'_>) -> Option<String> {
2175 self.expr.map(|body| print_const_expr(tcx, body))
2177 /// Will always be a machine readable number, without underscores or suffixes.
2178 pub(crate) fn value(&self, tcx: TyCtxt<'_>) -> String {
2179 print_evaluated_const(tcx, self.value, false).unwrap()
2183 /// Small wrapper around [`rustc_span::Span`] that adds helper methods
2184 /// and enforces calling [`rustc_span::Span::source_callsite()`].
2185 #[derive(Copy, Clone, Debug)]
2186 pub(crate) struct Span(rustc_span::Span);
2189 /// Wraps a [`rustc_span::Span`]. In case this span is the result of a macro expansion, the
2190 /// span will be updated to point to the macro invocation instead of the macro definition.
2192 /// (See rust-lang/rust#39726)
2193 pub(crate) fn new(sp: rustc_span::Span) -> Self {
2194 Self(sp.source_callsite())
2197 pub(crate) fn inner(&self) -> rustc_span::Span {
2201 pub(crate) fn filename(&self, sess: &Session) -> FileName {
2202 sess.source_map().span_to_filename(self.0)
2205 pub(crate) fn lo(&self, sess: &Session) -> Loc {
2206 sess.source_map().lookup_char_pos(self.0.lo())
2209 pub(crate) fn hi(&self, sess: &Session) -> Loc {
2210 sess.source_map().lookup_char_pos(self.0.hi())
2213 pub(crate) fn cnum(&self, sess: &Session) -> CrateNum {
2214 // FIXME: is there a time when the lo and hi crate would be different?
2215 self.lo(sess).file.cnum
2219 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2220 pub(crate) struct Path {
2221 pub(crate) res: Res,
2222 pub(crate) segments: ThinVec<PathSegment>,
2226 pub(crate) fn def_id(&self) -> DefId {
2230 pub(crate) fn last_opt(&self) -> Option<Symbol> {
2231 self.segments.last().map(|s| s.name)
2234 pub(crate) fn last(&self) -> Symbol {
2235 self.last_opt().expect("segments were empty")
2238 pub(crate) fn whole_name(&self) -> String {
2241 .map(|s| if s.name == kw::PathRoot { "" } else { s.name.as_str() })
2246 /// Checks if this is a `T::Name` path for an associated type.
2247 pub(crate) fn is_assoc_ty(&self) -> bool {
2249 Res::SelfTyParam { .. } | Res::SelfTyAlias { .. } | Res::Def(DefKind::TyParam, _)
2250 if self.segments.len() != 1 =>
2254 Res::Def(DefKind::AssocTy, _) => true,
2259 pub(crate) fn generics(&self) -> Option<Vec<&Type>> {
2260 self.segments.last().and_then(|seg| {
2261 if let GenericArgs::AngleBracketed { ref args, .. } = seg.args {
2264 .filter_map(|arg| match arg {
2265 GenericArg::Type(ty) => Some(ty),
2276 pub(crate) fn bindings(&self) -> Option<&[TypeBinding]> {
2277 self.segments.last().and_then(|seg| {
2278 if let GenericArgs::AngleBracketed { ref bindings, .. } = seg.args {
2287 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2288 pub(crate) enum GenericArg {
2291 Const(Box<Constant>),
2295 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2296 pub(crate) enum GenericArgs {
2297 AngleBracketed { args: Box<[GenericArg]>, bindings: ThinVec<TypeBinding> },
2298 Parenthesized { inputs: Box<[Type]>, output: Option<Box<Type>> },
2301 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2302 pub(crate) struct PathSegment {
2303 pub(crate) name: Symbol,
2304 pub(crate) args: GenericArgs,
2307 #[derive(Clone, Debug)]
2308 pub(crate) struct Typedef {
2309 pub(crate) type_: Type,
2310 pub(crate) generics: Generics,
2311 /// `type_` can come from either the HIR or from metadata. If it comes from HIR, it may be a type
2312 /// alias instead of the final type. This will always have the final type, regardless of whether
2313 /// `type_` came from HIR or from metadata.
2315 /// If `item_type.is_none()`, `type_` is guaranteed to come from metadata (and therefore hold the
2317 pub(crate) item_type: Option<Type>,
2320 #[derive(Clone, Debug)]
2321 pub(crate) struct OpaqueTy {
2322 pub(crate) bounds: Vec<GenericBound>,
2323 pub(crate) generics: Generics,
2326 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2327 pub(crate) struct BareFunctionDecl {
2328 pub(crate) unsafety: hir::Unsafety,
2329 pub(crate) generic_params: Vec<GenericParamDef>,
2330 pub(crate) decl: FnDecl,
2331 pub(crate) abi: Abi,
2334 #[derive(Clone, Debug)]
2335 pub(crate) struct Static {
2336 pub(crate) type_: Type,
2337 pub(crate) mutability: Mutability,
2338 pub(crate) expr: Option<BodyId>,
2341 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2342 pub(crate) struct Constant {
2343 pub(crate) type_: Type,
2344 pub(crate) kind: ConstantKind,
2347 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2348 pub(crate) enum Term {
2354 pub(crate) fn ty(&self) -> Option<&Type> {
2355 if let Term::Type(ty) = self { Some(ty) } else { None }
2359 impl From<Type> for Term {
2360 fn from(ty: Type) -> Self {
2365 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2366 pub(crate) enum ConstantKind {
2367 /// This is the wrapper around `ty::Const` for a non-local constant. Because it doesn't have a
2368 /// `BodyId`, we need to handle it on its own.
2370 /// Note that `ty::Const` includes generic parameters, and may not always be uniquely identified
2371 /// by a DefId. So this field must be different from `Extern`.
2372 TyConst { expr: Box<str> },
2373 /// A constant (expression) that's not an item or associated item. These are usually found
2374 /// nested inside types (e.g., array lengths) or expressions (e.g., repeat counts), and also
2375 /// used to define explicit discriminant values for enum variants.
2376 Anonymous { body: BodyId },
2377 /// A constant from a different crate.
2378 Extern { def_id: DefId },
2379 /// `const FOO: u32 = ...;`
2380 Local { def_id: DefId, body: BodyId },
2384 pub(crate) fn expr(&self, tcx: TyCtxt<'_>) -> String {
2388 pub(crate) fn value(&self, tcx: TyCtxt<'_>) -> Option<String> {
2389 self.kind.value(tcx)
2392 pub(crate) fn is_literal(&self, tcx: TyCtxt<'_>) -> bool {
2393 self.kind.is_literal(tcx)
2398 pub(crate) fn expr(&self, tcx: TyCtxt<'_>) -> String {
2400 ConstantKind::TyConst { ref expr } => expr.to_string(),
2401 ConstantKind::Extern { def_id } => print_inlined_const(tcx, def_id),
2402 ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2403 print_const_expr(tcx, body)
2408 pub(crate) fn value(&self, tcx: TyCtxt<'_>) -> Option<String> {
2410 ConstantKind::TyConst { .. } | ConstantKind::Anonymous { .. } => None,
2411 ConstantKind::Extern { def_id } | ConstantKind::Local { def_id, .. } => {
2412 print_evaluated_const(tcx, def_id, true)
2417 pub(crate) fn is_literal(&self, tcx: TyCtxt<'_>) -> bool {
2419 ConstantKind::TyConst { .. } => false,
2420 ConstantKind::Extern { def_id } => def_id.as_local().map_or(false, |def_id| {
2421 is_literal_expr(tcx, tcx.hir().local_def_id_to_hir_id(def_id))
2423 ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2424 is_literal_expr(tcx, body.hir_id)
2430 #[derive(Clone, Debug)]
2431 pub(crate) struct Impl {
2432 pub(crate) unsafety: hir::Unsafety,
2433 pub(crate) generics: Generics,
2434 pub(crate) trait_: Option<Path>,
2435 pub(crate) for_: Type,
2436 pub(crate) items: Vec<Item>,
2437 pub(crate) polarity: ty::ImplPolarity,
2438 pub(crate) kind: ImplKind,
2442 pub(crate) fn provided_trait_methods(&self, tcx: TyCtxt<'_>) -> FxHashSet<Symbol> {
2445 .map(|t| t.def_id())
2446 .map(|did| tcx.provided_trait_methods(did).map(|meth| meth.name).collect())
2447 .unwrap_or_default()
2451 #[derive(Clone, Debug)]
2452 pub(crate) enum ImplKind {
2460 pub(crate) fn is_auto(&self) -> bool {
2461 matches!(self, ImplKind::Auto)
2464 pub(crate) fn is_blanket(&self) -> bool {
2465 matches!(self, ImplKind::Blanket(_))
2468 pub(crate) fn is_fake_variadic(&self) -> bool {
2469 matches!(self, ImplKind::FakeVaradic)
2472 pub(crate) fn as_blanket_ty(&self) -> Option<&Type> {
2474 ImplKind::Blanket(ty) => Some(ty),
2480 #[derive(Clone, Debug)]
2481 pub(crate) struct Import {
2482 pub(crate) kind: ImportKind,
2483 pub(crate) source: ImportSource,
2484 pub(crate) should_be_displayed: bool,
2488 pub(crate) fn new_simple(
2490 source: ImportSource,
2491 should_be_displayed: bool,
2493 Self { kind: ImportKind::Simple(name), source, should_be_displayed }
2496 pub(crate) fn new_glob(source: ImportSource, should_be_displayed: bool) -> Self {
2497 Self { kind: ImportKind::Glob, source, should_be_displayed }
2500 pub(crate) fn imported_item_is_doc_hidden(&self, tcx: TyCtxt<'_>) -> bool {
2501 match self.source.did {
2503 .get_attrs(did, sym::doc)
2504 .filter_map(ast::Attribute::meta_item_list)
2506 .has_word(sym::hidden),
2512 #[derive(Clone, Debug)]
2513 pub(crate) enum ImportKind {
2514 // use source as str;
2520 #[derive(Clone, Debug)]
2521 pub(crate) struct ImportSource {
2522 pub(crate) path: Path,
2523 pub(crate) did: Option<DefId>,
2526 #[derive(Clone, Debug)]
2527 pub(crate) struct Macro {
2528 pub(crate) source: String,
2531 #[derive(Clone, Debug)]
2532 pub(crate) struct ProcMacro {
2533 pub(crate) kind: MacroKind,
2534 pub(crate) helpers: Vec<Symbol>,
2537 /// An type binding on an associated type (e.g., `A = Bar` in `Foo<A = Bar>` or
2538 /// `A: Send + Sync` in `Foo<A: Send + Sync>`).
2539 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2540 pub(crate) struct TypeBinding {
2541 pub(crate) assoc: PathSegment,
2542 pub(crate) kind: TypeBindingKind,
2545 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2546 pub(crate) enum TypeBindingKind {
2547 Equality { term: Term },
2548 Constraint { bounds: Vec<GenericBound> },
2552 pub(crate) fn term(&self) -> &Term {
2554 TypeBindingKind::Equality { ref term } => term,
2555 _ => panic!("expected equality type binding for parenthesized generic args"),
2560 /// The type, lifetime, or constant that a private type alias's parameter should be
2561 /// replaced with when expanding a use of that type alias.
2566 /// type PrivAlias<T> = Vec<T>;
2568 /// pub fn public_fn() -> PrivAlias<i32> { vec![] }
2571 /// `public_fn`'s docs will show it as returning `Vec<i32>`, since `PrivAlias` is private.
2572 /// [`SubstParam`] is used to record that `T` should be mapped to `i32`.
2573 pub(crate) enum SubstParam {
2580 pub(crate) fn as_ty(&self) -> Option<&Type> {
2581 if let Self::Type(ty) = self { Some(ty) } else { None }
2584 pub(crate) fn as_lt(&self) -> Option<&Lifetime> {
2585 if let Self::Lifetime(lt) = self { Some(lt) } else { None }
2589 // Some nodes are used a lot. Make sure they don't unintentionally get bigger.
2590 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2593 use rustc_data_structures::static_assert_size;
2594 // tidy-alphabetical-start
2595 static_assert_size!(Crate, 64); // frequently moved by-value
2596 static_assert_size!(DocFragment, 32);
2597 static_assert_size!(GenericArg, 32);
2598 static_assert_size!(GenericArgs, 32);
2599 static_assert_size!(GenericParamDef, 56);
2600 static_assert_size!(Generics, 16);
2601 static_assert_size!(Item, 56);
2602 static_assert_size!(ItemKind, 64);
2603 static_assert_size!(PathSegment, 40);
2604 static_assert_size!(Type, 32);
2605 // tidy-alphabetical-end