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 pub(crate) fn from_def_id_and_parts(
444 name: Option<Symbol>,
446 cx: &mut DocContext<'_>,
448 let ast_attrs = cx.tcx.get_attrs_unchecked(def_id);
450 Self::from_def_id_and_attrs_and_parts(
454 Box::new(Attributes::from_ast(ast_attrs)),
455 ast_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
459 pub(crate) fn from_def_id_and_attrs_and_parts(
461 name: Option<Symbol>,
463 attrs: Box<Attributes>,
464 cfg: Option<Arc<Cfg>>,
466 trace!("name={:?}, def_id={:?} cfg={:?}", name, def_id, cfg);
469 item_id: def_id.into(),
470 kind: Box::new(kind),
474 inline_stmt_id: None,
478 /// Finds all `doc` attributes as NameValues and returns their corresponding values, joined
480 pub(crate) fn collapsed_doc_value(&self) -> Option<String> {
481 self.attrs.collapsed_doc_value()
484 pub(crate) fn links(&self, cx: &Context<'_>) -> Vec<RenderedLink> {
485 use crate::html::format::href;
490 .map_or(&[][..], |v| v.as_slice())
492 .filter_map(|ItemLink { link: s, link_text, page_id: did, ref fragment }| {
494 if let Ok((mut href, ..)) = href(*did, cx) {
496 if let Some(ref fragment) = *fragment {
497 fragment.render(&mut href, cx.tcx())
500 original_text: s.clone(),
501 new_text: link_text.clone(),
511 /// Find a list of all link names, without finding their href.
513 /// This is used for generating summary text, which does not include
514 /// the link text, but does need to know which `[]`-bracketed names
515 /// are actually links.
516 pub(crate) fn link_names(&self, cache: &Cache) -> Vec<RenderedLink> {
520 .map_or(&[][..], |v| v.as_slice())
522 .map(|ItemLink { link: s, link_text, .. }| RenderedLink {
523 original_text: s.clone(),
524 new_text: link_text.clone(),
530 pub(crate) fn is_crate(&self) -> bool {
531 self.is_mod() && self.item_id.as_def_id().map_or(false, |did| did.is_crate_root())
533 pub(crate) fn is_mod(&self) -> bool {
534 self.type_() == ItemType::Module
536 pub(crate) fn is_trait(&self) -> bool {
537 self.type_() == ItemType::Trait
539 pub(crate) fn is_struct(&self) -> bool {
540 self.type_() == ItemType::Struct
542 pub(crate) fn is_enum(&self) -> bool {
543 self.type_() == ItemType::Enum
545 pub(crate) fn is_variant(&self) -> bool {
546 self.type_() == ItemType::Variant
548 pub(crate) fn is_associated_type(&self) -> bool {
549 matches!(&*self.kind, AssocTypeItem(..) | StrippedItem(box AssocTypeItem(..)))
551 pub(crate) fn is_ty_associated_type(&self) -> bool {
552 matches!(&*self.kind, TyAssocTypeItem(..) | StrippedItem(box TyAssocTypeItem(..)))
554 pub(crate) fn is_associated_const(&self) -> bool {
555 matches!(&*self.kind, AssocConstItem(..) | StrippedItem(box AssocConstItem(..)))
557 pub(crate) fn is_ty_associated_const(&self) -> bool {
558 matches!(&*self.kind, TyAssocConstItem(..) | StrippedItem(box TyAssocConstItem(..)))
560 pub(crate) fn is_method(&self) -> bool {
561 self.type_() == ItemType::Method
563 pub(crate) fn is_ty_method(&self) -> bool {
564 self.type_() == ItemType::TyMethod
566 pub(crate) fn is_typedef(&self) -> bool {
567 self.type_() == ItemType::Typedef
569 pub(crate) fn is_primitive(&self) -> bool {
570 self.type_() == ItemType::Primitive
572 pub(crate) fn is_union(&self) -> bool {
573 self.type_() == ItemType::Union
575 pub(crate) fn is_import(&self) -> bool {
576 self.type_() == ItemType::Import
578 pub(crate) fn is_extern_crate(&self) -> bool {
579 self.type_() == ItemType::ExternCrate
581 pub(crate) fn is_keyword(&self) -> bool {
582 self.type_() == ItemType::Keyword
584 pub(crate) fn is_stripped(&self) -> bool {
586 StrippedItem(..) => true,
587 ImportItem(ref i) => !i.should_be_displayed,
591 pub(crate) fn has_stripped_entries(&self) -> Option<bool> {
593 StructItem(ref struct_) => Some(struct_.has_stripped_entries()),
594 UnionItem(ref union_) => Some(union_.has_stripped_entries()),
595 EnumItem(ref enum_) => Some(enum_.has_stripped_entries()),
596 VariantItem(ref v) => v.has_stripped_entries(),
601 pub(crate) fn stability_class(&self, tcx: TyCtxt<'_>) -> Option<String> {
602 self.stability(tcx).as_ref().and_then(|s| {
603 let mut classes = Vec::with_capacity(2);
606 classes.push("unstable");
609 // FIXME: what about non-staged API items that are deprecated?
610 if self.deprecation(tcx).is_some() {
611 classes.push("deprecated");
614 if !classes.is_empty() { Some(classes.join(" ")) } else { None }
618 pub(crate) fn stable_since(&self, tcx: TyCtxt<'_>) -> Option<Symbol> {
619 match self.stability(tcx)?.level {
620 StabilityLevel::Stable { since, .. } => Some(since),
621 StabilityLevel::Unstable { .. } => None,
625 pub(crate) fn const_stable_since(&self, tcx: TyCtxt<'_>) -> Option<Symbol> {
626 match self.const_stability(tcx)?.level {
627 StabilityLevel::Stable { since, .. } => Some(since),
628 StabilityLevel::Unstable { .. } => None,
632 pub(crate) fn is_non_exhaustive(&self) -> bool {
633 self.attrs.other_attrs.iter().any(|a| a.has_name(sym::non_exhaustive))
636 /// Returns a documentation-level item type from the item.
637 pub(crate) fn type_(&self) -> ItemType {
641 pub(crate) fn is_default(&self) -> bool {
643 ItemKind::MethodItem(_, Some(defaultness)) => {
644 defaultness.has_value() && !defaultness.is_final()
650 /// Returns a `FnHeader` if `self` is a function item, otherwise returns `None`.
651 pub(crate) fn fn_header(&self, tcx: TyCtxt<'_>) -> Option<hir::FnHeader> {
655 asyncness: hir::IsAsync,
657 let sig = tcx.fn_sig(def_id).skip_binder();
659 if tcx.is_const_fn(def_id) && is_unstable_const_fn(tcx, def_id).is_none() {
660 hir::Constness::Const
662 hir::Constness::NotConst
664 hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness }
666 let header = match *self.kind {
667 ItemKind::ForeignFunctionItem(_) => {
668 let def_id = self.item_id.as_def_id().unwrap();
669 let abi = tcx.fn_sig(def_id).skip_binder().abi();
671 unsafety: if abi == Abi::RustIntrinsic {
672 intrinsic_operation_unsafety(tcx, self.item_id.as_def_id().unwrap())
674 hir::Unsafety::Unsafe
677 constness: if abi == Abi::RustIntrinsic
678 && tcx.is_const_fn(def_id)
679 && is_unstable_const_fn(tcx, def_id).is_none()
681 hir::Constness::Const
683 hir::Constness::NotConst
685 asyncness: hir::IsAsync::NotAsync,
688 ItemKind::FunctionItem(_) | ItemKind::MethodItem(_, _) | ItemKind::TyMethodItem(_) => {
689 let def_id = self.item_id.as_def_id().unwrap();
690 build_fn_header(def_id, tcx, tcx.asyncness(def_id))
697 /// Returns the visibility of the current item. If the visibility is "inherited", then `None`
699 pub(crate) fn visibility(&self, tcx: TyCtxt<'_>) -> Option<Visibility<DefId>> {
700 let def_id = match self.item_id {
701 // Anything but DefId *shouldn't* matter, but return a reasonable value anyway.
702 ItemId::Auto { .. } | ItemId::Blanket { .. } => return None,
703 ItemId::DefId(def_id) => def_id,
707 // Primitives and Keywords are written in the source code as private modules.
708 // The modules need to be private so that nobody actually uses them, but the
709 // keywords and primitives that they are documenting are public.
710 ItemKind::KeywordItem | ItemKind::PrimitiveItem(_) => return Some(Visibility::Public),
711 // Variant fields inherit their enum's visibility.
712 StructFieldItem(..) if is_field_vis_inherited(tcx, def_id) => {
715 // Variants always inherit visibility
716 VariantItem(..) => return None,
717 // Trait items inherit the trait's visibility
718 AssocConstItem(..) | TyAssocConstItem(..) | AssocTypeItem(..) | TyAssocTypeItem(..)
719 | TyMethodItem(..) | MethodItem(..) => {
720 let assoc_item = tcx.associated_item(def_id);
721 let is_trait_item = match assoc_item.container {
722 ty::TraitContainer => true,
723 ty::ImplContainer => {
724 // Trait impl items always inherit the impl's visibility --
725 // we don't want to show `pub`.
726 tcx.impl_trait_ref(tcx.parent(assoc_item.def_id)).is_some()
735 let def_id = match self.inline_stmt_id {
736 Some(inlined) => inlined,
739 Some(tcx.visibility(def_id))
743 #[derive(Clone, Debug)]
744 pub(crate) enum ItemKind {
746 /// The crate's name, *not* the name it's imported as.
753 FunctionItem(Box<Function>),
755 TypedefItem(Box<Typedef>),
756 OpaqueTyItem(OpaqueTy),
758 ConstantItem(Constant),
759 TraitItem(Box<Trait>),
760 TraitAliasItem(TraitAlias),
762 /// A required method in a trait declaration meaning it's only a function signature.
763 TyMethodItem(Box<Function>),
764 /// A method in a trait impl or a provided method in a trait declaration.
766 /// Compared to [TyMethodItem], it also contains a method body.
767 MethodItem(Box<Function>, Option<hir::Defaultness>),
768 StructFieldItem(Type),
769 VariantItem(Variant),
770 /// `fn`s from an extern block
771 ForeignFunctionItem(Box<Function>),
772 /// `static`s from an extern block
773 ForeignStaticItem(Static),
774 /// `type`s from an extern block
777 ProcMacroItem(ProcMacro),
778 PrimitiveItem(PrimitiveType),
779 /// A required associated constant in a trait declaration.
780 TyAssocConstItem(Type),
781 /// An associated associated constant in a trait impl or a provided one in a trait declaration.
782 AssocConstItem(Type, ConstantKind),
783 /// A required associated type in a trait declaration.
785 /// The bounds may be non-empty if there is a `where` clause.
786 TyAssocTypeItem(Generics, Vec<GenericBound>),
787 /// An associated type in a trait impl or a provided one in a trait declaration.
788 AssocTypeItem(Box<Typedef>, Vec<GenericBound>),
789 /// An item that has been stripped by a rustdoc pass
790 StrippedItem(Box<ItemKind>),
795 /// Some items contain others such as structs (for their fields) and Enums
796 /// (for their variants). This method returns those contained items.
797 pub(crate) fn inner_items(&self) -> impl Iterator<Item = &Item> {
799 StructItem(s) => s.fields.iter(),
800 UnionItem(u) => u.fields.iter(),
801 VariantItem(v) => match &v.kind {
802 VariantKind::CLike => [].iter(),
803 VariantKind::Tuple(t) => t.iter(),
804 VariantKind::Struct(s) => s.fields.iter(),
806 EnumItem(e) => e.variants.iter(),
807 TraitItem(t) => t.items.iter(),
808 ImplItem(i) => i.items.iter(),
809 ModuleItem(m) => m.items.iter(),
810 ExternCrateItem { .. }
821 | ForeignFunctionItem(_)
822 | ForeignStaticItem(_)
827 | TyAssocConstItem(_)
828 | AssocConstItem(_, _)
829 | TyAssocTypeItem(..)
832 | KeywordItem => [].iter(),
836 /// Returns `true` if this item does not appear inside an impl block.
837 pub(crate) fn is_non_assoc(&self) -> bool {
845 | ExternCrateItem { .. }
852 | ForeignFunctionItem(_)
853 | ForeignStaticItem(_)
862 #[derive(Clone, Debug)]
863 pub(crate) struct Module {
864 pub(crate) items: Vec<Item>,
865 pub(crate) span: Span,
868 pub(crate) trait AttributesExt {
869 type AttributeIterator<'a>: Iterator<Item = ast::NestedMetaItem>
873 fn lists<'a>(&'a self, name: Symbol) -> Self::AttributeIterator<'a>;
875 fn span(&self) -> Option<rustc_span::Span>;
877 fn inner_docs(&self) -> bool;
879 fn cfg(&self, tcx: TyCtxt<'_>, hidden_cfg: &FxHashSet<Cfg>) -> Option<Arc<Cfg>>;
882 impl AttributesExt for [ast::Attribute] {
883 type AttributeIterator<'a> = impl Iterator<Item = ast::NestedMetaItem> + 'a;
885 fn lists<'a>(&'a self, name: Symbol) -> Self::AttributeIterator<'a> {
887 .filter(move |attr| attr.has_name(name))
888 .filter_map(ast::Attribute::meta_item_list)
892 /// Return the span of the first doc-comment, if it exists.
893 fn span(&self) -> Option<rustc_span::Span> {
894 self.iter().find(|attr| attr.doc_str().is_some()).map(|attr| attr.span)
897 /// Returns whether the first doc-comment is an inner attribute.
899 //// If there are no doc-comments, return true.
900 /// FIXME(#78591): Support both inner and outer attributes on the same item.
901 fn inner_docs(&self) -> bool {
902 self.iter().find(|a| a.doc_str().is_some()).map_or(true, |a| a.style == AttrStyle::Inner)
905 fn cfg(&self, tcx: TyCtxt<'_>, hidden_cfg: &FxHashSet<Cfg>) -> Option<Arc<Cfg>> {
907 let doc_cfg_active = tcx.features().doc_cfg;
908 let doc_auto_cfg_active = tcx.features().doc_auto_cfg;
910 fn single<T: IntoIterator>(it: T) -> Option<T::Item> {
911 let mut iter = it.into_iter();
912 let item = iter.next()?;
913 if iter.next().is_some() {
919 let mut cfg = if doc_cfg_active || doc_auto_cfg_active {
920 let mut doc_cfg = self
922 .filter(|attr| attr.has_name(sym::doc))
923 .flat_map(|attr| attr.meta_item_list().unwrap_or_default())
924 .filter(|attr| attr.has_name(sym::cfg))
926 if doc_cfg.peek().is_some() && doc_cfg_active {
928 .filter_map(|attr| Cfg::parse(attr.meta_item()?).ok())
929 .fold(Cfg::True, |cfg, new_cfg| cfg & new_cfg)
930 } else if doc_auto_cfg_active {
932 .filter(|attr| attr.has_name(sym::cfg))
933 .filter_map(|attr| single(attr.meta_item_list()?))
935 Cfg::parse_without(attr.meta_item()?, hidden_cfg).ok().flatten()
937 .fold(Cfg::True, |cfg, new_cfg| cfg & new_cfg)
945 for attr in self.iter() {
947 if attr.doc_str().is_none() && attr.has_name(sym::doc) {
949 if let Some(list) = attr.meta().as_ref().and_then(|mi| mi.meta_item_list()) {
952 if !item.has_name(sym::cfg) {
956 if let Some(cfg_mi) = item
958 .and_then(|item| rustc_expand::config::parse_cfg(item, sess))
960 match Cfg::parse(cfg_mi) {
961 Ok(new_cfg) => cfg &= new_cfg,
963 sess.span_err(e.span, e.msg);
972 // treat #[target_feature(enable = "feat")] attributes as if they were
973 // #[doc(cfg(target_feature = "feat"))] attributes as well
974 for attr in self.lists(sym::target_feature) {
975 if attr.has_name(sym::enable) {
976 if attr.value_str().is_some() {
977 // Clone `enable = "feat"`, change to `target_feature = "feat"`.
978 // Unwrap is safe because `value_str` succeeded above.
979 let mut meta = attr.meta_item().unwrap().clone();
980 meta.path = ast::Path::from_ident(Ident::with_dummy_span(sym::target_feature));
982 if let Ok(feat_cfg) = Cfg::parse(&meta) {
989 if cfg == Cfg::True { None } else { Some(Arc::new(cfg)) }
993 pub(crate) trait NestedAttributesExt {
994 /// Returns `true` if the attribute list contains a specific `word`
995 fn has_word(self, word: Symbol) -> bool
997 Self: std::marker::Sized,
999 <Self as NestedAttributesExt>::get_word_attr(self, word).is_some()
1002 /// Returns `Some(attr)` if the attribute list contains 'attr'
1003 /// corresponding to a specific `word`
1004 fn get_word_attr(self, word: Symbol) -> Option<ast::NestedMetaItem>;
1007 impl<I: Iterator<Item = ast::NestedMetaItem>> NestedAttributesExt for I {
1008 fn get_word_attr(mut self, word: Symbol) -> Option<ast::NestedMetaItem> {
1009 self.find(|attr| attr.is_word() && attr.has_name(word))
1013 /// A portion of documentation, extracted from a `#[doc]` attribute.
1015 /// Each variant contains the line number within the complete doc-comment where the fragment
1016 /// starts, as well as the Span where the corresponding doc comment or attribute is located.
1018 /// Included files are kept separate from inline doc comments so that proper line-number
1019 /// information can be given when a doctest fails. Sugared doc comments and "raw" doc comments are
1020 /// kept separate because of issue #42760.
1021 #[derive(Clone, PartialEq, Eq, Debug)]
1022 pub(crate) struct DocFragment {
1023 pub(crate) span: rustc_span::Span,
1024 /// The module this doc-comment came from.
1026 /// This allows distinguishing between the original documentation and a pub re-export.
1027 /// If it is `None`, the item was not re-exported.
1028 pub(crate) parent_module: Option<DefId>,
1029 pub(crate) doc: Symbol,
1030 pub(crate) kind: DocFragmentKind,
1031 pub(crate) indent: usize,
1034 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
1035 pub(crate) enum DocFragmentKind {
1036 /// A doc fragment created from a `///` or `//!` doc comment.
1038 /// A doc fragment created from a "raw" `#[doc=""]` attribute.
1042 /// The goal of this function is to apply the `DocFragment` transformation that is required when
1043 /// transforming into the final Markdown, which is applying the computed indent to each line in
1044 /// each doc fragment (a `DocFragment` can contain multiple lines in case of `#[doc = ""]`).
1046 /// Note: remove the trailing newline where appropriate
1047 fn add_doc_fragment(out: &mut String, frag: &DocFragment) {
1048 let s = frag.doc.as_str();
1049 let mut iter = s.lines();
1054 while let Some(line) = iter.next() {
1055 if line.chars().any(|c| !c.is_whitespace()) {
1056 assert!(line.len() >= frag.indent);
1057 out.push_str(&line[frag.indent..]);
1065 /// Collapse a collection of [`DocFragment`]s into one string,
1066 /// handling indentation and newlines as needed.
1067 pub(crate) fn collapse_doc_fragments(doc_strings: &[DocFragment]) -> String {
1068 let mut acc = String::new();
1069 for frag in doc_strings {
1070 add_doc_fragment(&mut acc, frag);
1076 /// Removes excess indentation on comments in order for the Markdown
1077 /// to be parsed correctly. This is necessary because the convention for
1078 /// writing documentation is to provide a space between the /// or //! marker
1079 /// and the doc text, but Markdown is whitespace-sensitive. For example,
1080 /// a block of text with four-space indentation is parsed as a code block,
1081 /// so if we didn't unindent comments, these list items
1088 /// would be parsed as if they were in a code block, which is likely not what the user intended.
1089 fn unindent_doc_fragments(docs: &mut Vec<DocFragment>) {
1090 // `add` is used in case the most common sugared doc syntax is used ("/// "). The other
1091 // fragments kind's lines are never starting with a whitespace unless they are using some
1092 // markdown formatting requiring it. Therefore, if the doc block have a mix between the two,
1093 // we need to take into account the fact that the minimum indent minus one (to take this
1094 // whitespace into account).
1099 // #[doc = "another"]
1101 // In this case, you want "hello! another" and not "hello! another".
1102 let add = if docs.windows(2).any(|arr| arr[0].kind != arr[1].kind)
1103 && docs.iter().any(|d| d.kind == DocFragmentKind::SugaredDoc)
1105 // In case we have a mix of sugared doc comments and "raw" ones, we want the sugared one to
1106 // "decide" how much the minimum indent will be.
1112 // `min_indent` is used to know how much whitespaces from the start of each lines must be
1113 // removed. Example:
1116 // #[doc = "another"]
1118 // In here, the `min_indent` is 1 (because non-sugared fragment are always counted with minimum
1119 // 1 whitespace), meaning that "hello!" will be considered a codeblock because it starts with 4
1120 // (5 - 1) whitespaces.
1121 let Some(min_indent) = docs
1124 fragment.doc.as_str().lines().fold(usize::MAX, |min_indent, line| {
1125 if line.chars().all(|c| c.is_whitespace()) {
1128 // Compare against either space or tab, ignoring whether they are
1130 let whitespace = line.chars().take_while(|c| *c == ' ' || *c == '\t').count();
1131 cmp::min(min_indent, whitespace)
1132 + if fragment.kind == DocFragmentKind::SugaredDoc { 0 } else { add }
1141 for fragment in docs {
1142 if fragment.doc == kw::Empty {
1146 let min_indent = if fragment.kind != DocFragmentKind::SugaredDoc && min_indent > 0 {
1152 fragment.indent = min_indent;
1156 /// A link that has not yet been rendered.
1158 /// This link will be turned into a rendered link by [`Item::links`].
1159 #[derive(Clone, Debug, PartialEq, Eq)]
1160 pub(crate) struct ItemLink {
1161 /// The original link written in the markdown
1162 pub(crate) link: String,
1163 /// The link text displayed in the HTML.
1165 /// This may not be the same as `link` if there was a disambiguator
1166 /// in an intra-doc link (e.g. \[`fn@f`\])
1167 pub(crate) link_text: String,
1168 /// The `DefId` of the Item whose **HTML Page** contains the item being
1169 /// linked to. This will be different to `item_id` on item's that don't
1170 /// have their own page, such as struct fields and enum variants.
1171 pub(crate) page_id: DefId,
1172 /// The url fragment to append to the link
1173 pub(crate) fragment: Option<UrlFragment>,
1176 pub struct RenderedLink {
1177 /// The text the link was original written as.
1179 /// This could potentially include disambiguators and backticks.
1180 pub(crate) original_text: String,
1181 /// The text to display in the HTML
1182 pub(crate) new_text: String,
1183 /// The URL to put in the `href`
1184 pub(crate) href: String,
1187 /// The attributes on an [`Item`], including attributes like `#[derive(...)]` and `#[inline]`,
1188 /// as well as doc comments.
1189 #[derive(Clone, Debug, Default)]
1190 pub(crate) struct Attributes {
1191 pub(crate) doc_strings: Vec<DocFragment>,
1192 pub(crate) other_attrs: ast::AttrVec,
1196 pub(crate) fn lists(&self, name: Symbol) -> impl Iterator<Item = ast::NestedMetaItem> + '_ {
1197 self.other_attrs.lists(name)
1200 pub(crate) fn has_doc_flag(&self, flag: Symbol) -> bool {
1201 for attr in &self.other_attrs {
1202 if !attr.has_name(sym::doc) {
1206 if let Some(items) = attr.meta_item_list() {
1207 if items.iter().filter_map(|i| i.meta_item()).any(|it| it.has_name(flag)) {
1216 pub(crate) fn from_ast(attrs: &[ast::Attribute]) -> Attributes {
1217 Attributes::from_ast_iter(attrs.iter().map(|attr| (attr, None)), false)
1220 pub(crate) fn from_ast_with_additional(
1221 attrs: &[ast::Attribute],
1222 (additional_attrs, def_id): (&[ast::Attribute], DefId),
1224 // Additional documentation should be shown before the original documentation.
1225 let attrs1 = additional_attrs.iter().map(|attr| (attr, Some(def_id)));
1226 let attrs2 = attrs.iter().map(|attr| (attr, None));
1227 Attributes::from_ast_iter(attrs1.chain(attrs2), false)
1230 pub(crate) fn from_ast_iter<'a>(
1231 attrs: impl Iterator<Item = (&'a ast::Attribute, Option<DefId>)>,
1234 let mut doc_strings = Vec::new();
1235 let mut other_attrs = ast::AttrVec::new();
1236 for (attr, parent_module) in attrs {
1237 if let Some((doc_str, comment_kind)) = attr.doc_str_and_comment_kind() {
1238 trace!("got doc_str={doc_str:?}");
1239 let doc = beautify_doc_string(doc_str, comment_kind);
1240 let kind = if attr.is_doc_comment() {
1241 DocFragmentKind::SugaredDoc
1243 DocFragmentKind::RawDoc
1245 let fragment = DocFragment { span: attr.span, doc, kind, parent_module, indent: 0 };
1246 doc_strings.push(fragment);
1247 } else if !doc_only {
1248 other_attrs.push(attr.clone());
1252 unindent_doc_fragments(&mut doc_strings);
1254 Attributes { doc_strings, other_attrs }
1257 /// Finds the `doc` attribute as a NameValue and returns the corresponding
1259 pub(crate) fn doc_value(&self) -> Option<String> {
1260 let mut iter = self.doc_strings.iter();
1262 let ori = iter.next()?;
1263 let mut out = String::new();
1264 add_doc_fragment(&mut out, ori);
1265 for new_frag in iter {
1266 add_doc_fragment(&mut out, new_frag);
1269 if out.is_empty() { None } else { Some(out) }
1272 /// Return the doc-comments on this item, grouped by the module they came from.
1273 /// The module can be different if this is a re-export with added documentation.
1275 /// The last newline is not trimmed so the produced strings are reusable between
1276 /// early and late doc link resolution regardless of their position.
1277 pub(crate) fn prepare_to_doc_link_resolution(&self) -> FxHashMap<Option<DefId>, String> {
1278 let mut res = FxHashMap::default();
1279 for fragment in &self.doc_strings {
1280 let out_str = res.entry(fragment.parent_module).or_default();
1281 add_doc_fragment(out_str, fragment);
1286 /// Finds all `doc` attributes as NameValues and returns their corresponding values, joined
1288 pub(crate) fn collapsed_doc_value(&self) -> Option<String> {
1289 if self.doc_strings.is_empty() {
1292 Some(collapse_doc_fragments(&self.doc_strings))
1296 pub(crate) fn get_doc_aliases(&self) -> Box<[Symbol]> {
1297 let mut aliases = FxHashSet::default();
1299 for attr in self.other_attrs.lists(sym::doc).filter(|a| a.has_name(sym::alias)) {
1300 if let Some(values) = attr.meta_item_list() {
1302 match l.lit().unwrap().kind {
1303 ast::LitKind::Str(s, _) => {
1306 _ => unreachable!(),
1310 aliases.insert(attr.value_str().unwrap());
1313 aliases.into_iter().collect::<Vec<_>>().into()
1317 impl PartialEq for Attributes {
1318 fn eq(&self, rhs: &Self) -> bool {
1319 self.doc_strings == rhs.doc_strings
1323 .map(|attr| attr.id)
1324 .eq(rhs.other_attrs.iter().map(|attr| attr.id))
1328 impl Eq for Attributes {}
1330 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1331 pub(crate) enum GenericBound {
1332 TraitBound(PolyTrait, hir::TraitBoundModifier),
1337 pub(crate) fn maybe_sized(cx: &mut DocContext<'_>) -> GenericBound {
1338 let did = cx.tcx.require_lang_item(LangItem::Sized, None);
1339 let empty = ty::Binder::dummy(ty::InternalSubsts::empty());
1340 let path = external_path(cx, did, false, ThinVec::new(), empty);
1341 inline::record_extern_fqn(cx, did, ItemType::Trait);
1342 GenericBound::TraitBound(
1343 PolyTrait { trait_: path, generic_params: Vec::new() },
1344 hir::TraitBoundModifier::Maybe,
1348 pub(crate) fn is_sized_bound(&self, cx: &DocContext<'_>) -> bool {
1349 use rustc_hir::TraitBoundModifier as TBM;
1350 if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, TBM::None) = *self {
1351 if Some(trait_.def_id()) == cx.tcx.lang_items().sized_trait() {
1358 pub(crate) fn get_poly_trait(&self) -> Option<PolyTrait> {
1359 if let GenericBound::TraitBound(ref p, _) = *self {
1360 return Some(p.clone());
1365 pub(crate) fn get_trait_path(&self) -> Option<Path> {
1366 if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, _) = *self {
1367 Some(trait_.clone())
1374 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1375 pub(crate) struct Lifetime(pub Symbol);
1378 pub(crate) fn statik() -> Lifetime {
1379 Lifetime(kw::StaticLifetime)
1382 pub(crate) fn elided() -> Lifetime {
1383 Lifetime(kw::UnderscoreLifetime)
1387 #[derive(Clone, Debug)]
1388 pub(crate) enum WherePredicate {
1389 BoundPredicate { ty: Type, bounds: Vec<GenericBound>, bound_params: Vec<Lifetime> },
1390 RegionPredicate { lifetime: Lifetime, bounds: Vec<GenericBound> },
1391 EqPredicate { lhs: Box<Type>, rhs: Box<Term>, bound_params: Vec<Lifetime> },
1394 impl WherePredicate {
1395 pub(crate) fn get_bounds(&self) -> Option<&[GenericBound]> {
1397 WherePredicate::BoundPredicate { ref bounds, .. } => Some(bounds),
1398 WherePredicate::RegionPredicate { ref bounds, .. } => Some(bounds),
1403 pub(crate) fn get_bound_params(&self) -> Option<&[Lifetime]> {
1405 Self::BoundPredicate { bound_params, .. } | Self::EqPredicate { bound_params, .. } => {
1413 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1414 pub(crate) enum GenericParamDefKind {
1415 Lifetime { outlives: Vec<Lifetime> },
1416 Type { did: DefId, bounds: Vec<GenericBound>, default: Option<Box<Type>>, synthetic: bool },
1417 Const { did: DefId, ty: Box<Type>, default: Option<Box<String>> },
1420 impl GenericParamDefKind {
1421 pub(crate) fn is_type(&self) -> bool {
1422 matches!(self, GenericParamDefKind::Type { .. })
1426 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1427 pub(crate) struct GenericParamDef {
1428 pub(crate) name: Symbol,
1429 pub(crate) kind: GenericParamDefKind,
1432 impl GenericParamDef {
1433 pub(crate) fn lifetime(name: Symbol) -> Self {
1434 Self { name, kind: GenericParamDefKind::Lifetime { outlives: Vec::new() } }
1437 pub(crate) fn is_synthetic_type_param(&self) -> bool {
1439 GenericParamDefKind::Lifetime { .. } | GenericParamDefKind::Const { .. } => false,
1440 GenericParamDefKind::Type { synthetic, .. } => synthetic,
1444 pub(crate) fn is_type(&self) -> bool {
1448 pub(crate) fn get_bounds(&self) -> Option<&[GenericBound]> {
1450 GenericParamDefKind::Type { ref bounds, .. } => Some(bounds),
1456 // maybe use a Generic enum and use Vec<Generic>?
1457 #[derive(Clone, Debug, Default)]
1458 pub(crate) struct Generics {
1459 pub(crate) params: ThinVec<GenericParamDef>,
1460 pub(crate) where_predicates: ThinVec<WherePredicate>,
1464 pub(crate) fn is_empty(&self) -> bool {
1465 self.params.is_empty() && self.where_predicates.is_empty()
1469 #[derive(Clone, Debug)]
1470 pub(crate) struct Function {
1471 pub(crate) decl: FnDecl,
1472 pub(crate) generics: Generics,
1475 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1476 pub(crate) struct FnDecl {
1477 pub(crate) inputs: Arguments,
1478 pub(crate) output: FnRetTy,
1479 pub(crate) c_variadic: bool,
1483 pub(crate) fn self_type(&self) -> Option<SelfTy> {
1484 self.inputs.values.get(0).and_then(|v| v.to_self())
1487 /// Returns the sugared return type for an async function.
1489 /// For example, if the return type is `impl std::future::Future<Output = i32>`, this function
1490 /// will return `i32`.
1494 /// This function will panic if the return type does not match the expected sugaring for async
1496 pub(crate) fn sugared_async_return_type(&self) -> FnRetTy {
1497 match &self.output {
1498 FnRetTy::Return(Type::ImplTrait(bounds)) => match &bounds[0] {
1499 GenericBound::TraitBound(PolyTrait { trait_, .. }, ..) => {
1500 let bindings = trait_.bindings().unwrap();
1501 let ret_ty = bindings[0].term();
1502 let ty = ret_ty.ty().expect("Unexpected constant return term");
1503 FnRetTy::Return(ty.clone())
1505 _ => panic!("unexpected desugaring of async function"),
1507 _ => panic!("unexpected desugaring of async function"),
1512 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1513 pub(crate) struct Arguments {
1514 pub(crate) values: Vec<Argument>,
1517 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1518 pub(crate) struct Argument {
1519 pub(crate) type_: Type,
1520 pub(crate) name: Symbol,
1521 /// This field is used to represent "const" arguments from the `rustc_legacy_const_generics`
1522 /// feature. More information in <https://github.com/rust-lang/rust/issues/83167>.
1523 pub(crate) is_const: bool,
1526 #[derive(Clone, PartialEq, Debug)]
1527 pub(crate) enum SelfTy {
1529 SelfBorrowed(Option<Lifetime>, Mutability),
1534 pub(crate) fn to_self(&self) -> Option<SelfTy> {
1535 if self.name != kw::SelfLower {
1538 if self.type_.is_self_type() {
1539 return Some(SelfValue);
1542 BorrowedRef { ref lifetime, mutability, ref type_ } if type_.is_self_type() => {
1543 Some(SelfBorrowed(lifetime.clone(), mutability))
1545 _ => Some(SelfExplicit(self.type_.clone())),
1550 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1551 pub(crate) enum FnRetTy {
1557 pub(crate) fn as_return(&self) -> Option<&Type> {
1559 Return(ret) => Some(ret),
1560 DefaultReturn => None,
1565 #[derive(Clone, Debug)]
1566 pub(crate) struct Trait {
1567 pub(crate) def_id: DefId,
1568 pub(crate) items: Vec<Item>,
1569 pub(crate) generics: Generics,
1570 pub(crate) bounds: Vec<GenericBound>,
1574 pub(crate) fn is_auto(&self, tcx: TyCtxt<'_>) -> bool {
1575 tcx.trait_is_auto(self.def_id)
1577 pub(crate) fn is_notable_trait(&self, tcx: TyCtxt<'_>) -> bool {
1578 tcx.is_doc_notable_trait(self.def_id)
1580 pub(crate) fn unsafety(&self, tcx: TyCtxt<'_>) -> hir::Unsafety {
1581 tcx.trait_def(self.def_id).unsafety
1585 #[derive(Clone, Debug)]
1586 pub(crate) struct TraitAlias {
1587 pub(crate) generics: Generics,
1588 pub(crate) bounds: Vec<GenericBound>,
1591 /// A trait reference, which may have higher ranked lifetimes.
1592 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1593 pub(crate) struct PolyTrait {
1594 pub(crate) trait_: Path,
1595 pub(crate) generic_params: Vec<GenericParamDef>,
1598 /// Rustdoc's representation of types, mostly based on the [`hir::Ty`].
1599 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1600 pub(crate) enum Type {
1601 /// A named type, which could be a trait.
1603 /// This is mostly Rustdoc's version of [`hir::Path`].
1604 /// It has to be different because Rustdoc's [`PathSegment`] can contain cleaned generics.
1605 Path { path: Path },
1606 /// A `dyn Trait` object: `dyn for<'a> Trait<'a> + Send + 'static`
1607 DynTrait(Vec<PolyTrait>, Option<Lifetime>),
1608 /// A type parameter.
1610 /// A primitive (aka, builtin) type.
1611 Primitive(PrimitiveType),
1612 /// A function pointer: `extern "ABI" fn(...) -> ...`
1613 BareFunction(Box<BareFunctionDecl>),
1614 /// A tuple type: `(i32, &str)`.
1616 /// A slice type (does *not* include the `&`): `[i32]`
1620 /// The `String` field is a stringified version of the array's length parameter.
1621 Array(Box<Type>, Box<str>),
1622 /// A raw pointer type: `*const i32`, `*mut i32`
1623 RawPointer(Mutability, Box<Type>),
1624 /// A reference type: `&i32`, `&'a mut Foo`
1625 BorrowedRef { lifetime: Option<Lifetime>, mutability: Mutability, type_: Box<Type> },
1627 /// A qualified path to an associated item: `<Type as Trait>::Name`
1628 QPath(Box<QPathData>),
1630 /// A type that is inferred: `_`
1633 /// An `impl Trait`: `impl TraitA + TraitB + ...`
1634 ImplTrait(Vec<GenericBound>),
1638 /// When comparing types for equality, it can help to ignore `&` wrapping.
1639 pub(crate) fn without_borrowed_ref(&self) -> &Type {
1640 let mut result = self;
1641 while let Type::BorrowedRef { type_, .. } = result {
1647 /// Check if two types are "potentially the same".
1648 /// This is different from `Eq`, because it knows that things like
1649 /// `Placeholder` are possible matches for everything.
1650 pub(crate) fn is_same(&self, other: &Self, cache: &Cache) -> bool {
1651 match (self, other) {
1653 (Type::Tuple(a), Type::Tuple(b)) => {
1654 a.len() == b.len() && a.iter().zip(b).all(|(a, b)| a.is_same(b, cache))
1656 (Type::Slice(a), Type::Slice(b)) => a.is_same(b, cache),
1657 (Type::Array(a, al), Type::Array(b, bl)) => al == bl && a.is_same(b, cache),
1658 (Type::RawPointer(mutability, type_), Type::RawPointer(b_mutability, b_type_)) => {
1659 mutability == b_mutability && type_.is_same(b_type_, cache)
1662 Type::BorrowedRef { mutability, type_, .. },
1663 Type::BorrowedRef { mutability: b_mutability, type_: b_type_, .. },
1664 ) => mutability == b_mutability && type_.is_same(b_type_, cache),
1665 // Placeholders and generics are equal to all other types.
1666 (Type::Infer, _) | (_, Type::Infer) => true,
1667 (Type::Generic(_), _) | (_, Type::Generic(_)) => true,
1668 // Other cases, such as primitives, just use recursion.
1671 .and_then(|a| Some((a, b.def_id(cache)?)))
1672 .map(|(a, b)| a == b)
1677 pub(crate) fn primitive_type(&self) -> Option<PrimitiveType> {
1679 Primitive(p) | BorrowedRef { type_: box Primitive(p), .. } => Some(p),
1680 Slice(..) | BorrowedRef { type_: box Slice(..), .. } => Some(PrimitiveType::Slice),
1681 Array(..) | BorrowedRef { type_: box Array(..), .. } => Some(PrimitiveType::Array),
1684 Some(PrimitiveType::Unit)
1686 Some(PrimitiveType::Tuple)
1689 RawPointer(..) => Some(PrimitiveType::RawPointer),
1690 BareFunction(..) => Some(PrimitiveType::Fn),
1695 /// Checks if this is a `T::Name` path for an associated type.
1696 pub(crate) fn is_assoc_ty(&self) -> bool {
1698 Type::Path { path, .. } => path.is_assoc_ty(),
1703 pub(crate) fn is_self_type(&self) -> bool {
1705 Generic(name) => name == kw::SelfUpper,
1710 pub(crate) fn generics(&self) -> Option<Vec<&Type>> {
1712 Type::Path { path, .. } => path.generics(),
1717 pub(crate) fn is_full_generic(&self) -> bool {
1718 matches!(self, Type::Generic(_))
1721 pub(crate) fn is_impl_trait(&self) -> bool {
1722 matches!(self, Type::ImplTrait(_))
1725 pub(crate) fn projection(&self) -> Option<(&Type, DefId, PathSegment)> {
1726 if let QPath(box QPathData { self_type, trait_, assoc, .. }) = self {
1727 Some((self_type, trait_.def_id(), assoc.clone()))
1733 fn inner_def_id(&self, cache: Option<&Cache>) -> Option<DefId> {
1734 let t: PrimitiveType = match *self {
1735 Type::Path { ref path } => return Some(path.def_id()),
1736 DynTrait(ref bounds, _) => return bounds.get(0).map(|b| b.trait_.def_id()),
1737 Primitive(p) => return cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
1738 BorrowedRef { type_: box Generic(..), .. } => PrimitiveType::Reference,
1739 BorrowedRef { ref type_, .. } => return type_.inner_def_id(cache),
1744 PrimitiveType::Tuple
1747 BareFunction(..) => PrimitiveType::Fn,
1748 Slice(..) => PrimitiveType::Slice,
1749 Array(..) => PrimitiveType::Array,
1750 RawPointer(..) => PrimitiveType::RawPointer,
1751 QPath(box QPathData { ref self_type, .. }) => return self_type.inner_def_id(cache),
1752 Generic(_) | Infer | ImplTrait(_) => return None,
1754 cache.and_then(|c| Primitive(t).def_id(c))
1757 /// Use this method to get the [DefId] of a [clean] AST node, including [PrimitiveType]s.
1759 /// [clean]: crate::clean
1760 pub(crate) fn def_id(&self, cache: &Cache) -> Option<DefId> {
1761 self.inner_def_id(Some(cache))
1765 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1766 pub(crate) struct QPathData {
1767 pub assoc: PathSegment,
1768 pub self_type: Type,
1769 /// FIXME: compute this field on demand.
1770 pub should_show_cast: bool,
1774 /// A primitive (aka, builtin) type.
1776 /// This represents things like `i32`, `str`, etc.
1778 /// N.B. This has to be different from [`hir::PrimTy`] because it also includes types that aren't
1779 /// paths, like [`Self::Unit`].
1780 #[derive(Clone, PartialEq, Eq, Hash, Copy, Debug)]
1781 pub(crate) enum PrimitiveType {
1809 type SimplifiedTypes = FxHashMap<PrimitiveType, ArrayVec<SimplifiedType, 3>>;
1810 impl PrimitiveType {
1811 pub(crate) fn from_hir(prim: hir::PrimTy) -> PrimitiveType {
1812 use ast::{FloatTy, IntTy, UintTy};
1814 hir::PrimTy::Int(IntTy::Isize) => PrimitiveType::Isize,
1815 hir::PrimTy::Int(IntTy::I8) => PrimitiveType::I8,
1816 hir::PrimTy::Int(IntTy::I16) => PrimitiveType::I16,
1817 hir::PrimTy::Int(IntTy::I32) => PrimitiveType::I32,
1818 hir::PrimTy::Int(IntTy::I64) => PrimitiveType::I64,
1819 hir::PrimTy::Int(IntTy::I128) => PrimitiveType::I128,
1820 hir::PrimTy::Uint(UintTy::Usize) => PrimitiveType::Usize,
1821 hir::PrimTy::Uint(UintTy::U8) => PrimitiveType::U8,
1822 hir::PrimTy::Uint(UintTy::U16) => PrimitiveType::U16,
1823 hir::PrimTy::Uint(UintTy::U32) => PrimitiveType::U32,
1824 hir::PrimTy::Uint(UintTy::U64) => PrimitiveType::U64,
1825 hir::PrimTy::Uint(UintTy::U128) => PrimitiveType::U128,
1826 hir::PrimTy::Float(FloatTy::F32) => PrimitiveType::F32,
1827 hir::PrimTy::Float(FloatTy::F64) => PrimitiveType::F64,
1828 hir::PrimTy::Str => PrimitiveType::Str,
1829 hir::PrimTy::Bool => PrimitiveType::Bool,
1830 hir::PrimTy::Char => PrimitiveType::Char,
1834 pub(crate) fn from_symbol(s: Symbol) -> Option<PrimitiveType> {
1836 sym::isize => Some(PrimitiveType::Isize),
1837 sym::i8 => Some(PrimitiveType::I8),
1838 sym::i16 => Some(PrimitiveType::I16),
1839 sym::i32 => Some(PrimitiveType::I32),
1840 sym::i64 => Some(PrimitiveType::I64),
1841 sym::i128 => Some(PrimitiveType::I128),
1842 sym::usize => Some(PrimitiveType::Usize),
1843 sym::u8 => Some(PrimitiveType::U8),
1844 sym::u16 => Some(PrimitiveType::U16),
1845 sym::u32 => Some(PrimitiveType::U32),
1846 sym::u64 => Some(PrimitiveType::U64),
1847 sym::u128 => Some(PrimitiveType::U128),
1848 sym::bool => Some(PrimitiveType::Bool),
1849 sym::char => Some(PrimitiveType::Char),
1850 sym::str => Some(PrimitiveType::Str),
1851 sym::f32 => Some(PrimitiveType::F32),
1852 sym::f64 => Some(PrimitiveType::F64),
1853 sym::array => Some(PrimitiveType::Array),
1854 sym::slice => Some(PrimitiveType::Slice),
1855 sym::tuple => Some(PrimitiveType::Tuple),
1856 sym::unit => Some(PrimitiveType::Unit),
1857 sym::pointer => Some(PrimitiveType::RawPointer),
1858 sym::reference => Some(PrimitiveType::Reference),
1859 kw::Fn => Some(PrimitiveType::Fn),
1860 sym::never => Some(PrimitiveType::Never),
1865 pub(crate) fn simplified_types() -> &'static SimplifiedTypes {
1866 use ty::fast_reject::SimplifiedType::*;
1867 use ty::{FloatTy, IntTy, UintTy};
1868 use PrimitiveType::*;
1869 static CELL: OnceCell<SimplifiedTypes> = OnceCell::new();
1871 let single = |x| iter::once(x).collect();
1872 CELL.get_or_init(move || {
1874 Isize => single(IntSimplifiedType(IntTy::Isize)),
1875 I8 => single(IntSimplifiedType(IntTy::I8)),
1876 I16 => single(IntSimplifiedType(IntTy::I16)),
1877 I32 => single(IntSimplifiedType(IntTy::I32)),
1878 I64 => single(IntSimplifiedType(IntTy::I64)),
1879 I128 => single(IntSimplifiedType(IntTy::I128)),
1880 Usize => single(UintSimplifiedType(UintTy::Usize)),
1881 U8 => single(UintSimplifiedType(UintTy::U8)),
1882 U16 => single(UintSimplifiedType(UintTy::U16)),
1883 U32 => single(UintSimplifiedType(UintTy::U32)),
1884 U64 => single(UintSimplifiedType(UintTy::U64)),
1885 U128 => single(UintSimplifiedType(UintTy::U128)),
1886 F32 => single(FloatSimplifiedType(FloatTy::F32)),
1887 F64 => single(FloatSimplifiedType(FloatTy::F64)),
1888 Str => single(StrSimplifiedType),
1889 Bool => single(BoolSimplifiedType),
1890 Char => single(CharSimplifiedType),
1891 Array => single(ArraySimplifiedType),
1892 Slice => single(SliceSimplifiedType),
1893 // FIXME: If we ever add an inherent impl for tuples
1894 // with different lengths, they won't show in rustdoc.
1896 // Either manually update this arrayvec at this point
1897 // or start with a more complex refactoring.
1898 Tuple => [TupleSimplifiedType(1), TupleSimplifiedType(2), TupleSimplifiedType(3)].into(),
1899 Unit => single(TupleSimplifiedType(0)),
1900 RawPointer => [PtrSimplifiedType(Mutability::Not), PtrSimplifiedType(Mutability::Mut)].into_iter().collect(),
1901 Reference => [RefSimplifiedType(Mutability::Not), RefSimplifiedType(Mutability::Mut)].into_iter().collect(),
1902 // FIXME: This will be wrong if we ever add inherent impls
1903 // for function pointers.
1904 Fn => single(FunctionSimplifiedType(1)),
1905 Never => single(NeverSimplifiedType),
1910 pub(crate) fn impls<'tcx>(&self, tcx: TyCtxt<'tcx>) -> impl Iterator<Item = DefId> + 'tcx {
1911 Self::simplified_types()
1915 .flat_map(move |&simp| tcx.incoherent_impls(simp))
1919 pub(crate) fn all_impls(tcx: TyCtxt<'_>) -> impl Iterator<Item = DefId> + '_ {
1920 Self::simplified_types()
1923 .flat_map(move |&simp| tcx.incoherent_impls(simp))
1927 pub(crate) fn as_sym(&self) -> Symbol {
1928 use PrimitiveType::*;
1930 Isize => sym::isize,
1936 Usize => sym::usize,
1947 Array => sym::array,
1948 Slice => sym::slice,
1949 Tuple => sym::tuple,
1951 RawPointer => sym::pointer,
1952 Reference => sym::reference,
1954 Never => sym::never,
1958 /// Returns the DefId of the module with `doc(primitive)` for this primitive type.
1959 /// Panics if there is no such module.
1961 /// This gives precedence to primitives defined in the current crate, and deprioritizes primitives defined in `core`,
1962 /// but otherwise, if multiple crates define the same primitive, there is no guarantee of which will be picked.
1963 /// In particular, if a crate depends on both `std` and another crate that also defines `doc(primitive)`, then
1964 /// it's entirely random whether `std` or the other crate is picked. (no_std crates are usually fine unless multiple dependencies define a primitive.)
1965 pub(crate) fn primitive_locations(tcx: TyCtxt<'_>) -> &FxHashMap<PrimitiveType, DefId> {
1966 static PRIMITIVE_LOCATIONS: OnceCell<FxHashMap<PrimitiveType, DefId>> = OnceCell::new();
1967 PRIMITIVE_LOCATIONS.get_or_init(|| {
1968 let mut primitive_locations = FxHashMap::default();
1969 // NOTE: technically this misses crates that are only passed with `--extern` and not loaded when checking the crate.
1970 // This is a degenerate case that I don't plan to support.
1971 for &crate_num in tcx.crates(()) {
1972 let e = ExternalCrate { crate_num };
1973 let crate_name = e.name(tcx);
1974 debug!(?crate_num, ?crate_name);
1975 for &(def_id, prim) in &e.primitives(tcx) {
1976 // HACK: try to link to std instead where possible
1977 if crate_name == sym::core && primitive_locations.contains_key(&prim) {
1980 primitive_locations.insert(prim, def_id);
1983 let local_primitives = ExternalCrate { crate_num: LOCAL_CRATE }.primitives(tcx);
1984 for (def_id, prim) in local_primitives {
1985 primitive_locations.insert(prim, def_id);
1992 impl From<ast::IntTy> for PrimitiveType {
1993 fn from(int_ty: ast::IntTy) -> PrimitiveType {
1995 ast::IntTy::Isize => PrimitiveType::Isize,
1996 ast::IntTy::I8 => PrimitiveType::I8,
1997 ast::IntTy::I16 => PrimitiveType::I16,
1998 ast::IntTy::I32 => PrimitiveType::I32,
1999 ast::IntTy::I64 => PrimitiveType::I64,
2000 ast::IntTy::I128 => PrimitiveType::I128,
2005 impl From<ast::UintTy> for PrimitiveType {
2006 fn from(uint_ty: ast::UintTy) -> PrimitiveType {
2008 ast::UintTy::Usize => PrimitiveType::Usize,
2009 ast::UintTy::U8 => PrimitiveType::U8,
2010 ast::UintTy::U16 => PrimitiveType::U16,
2011 ast::UintTy::U32 => PrimitiveType::U32,
2012 ast::UintTy::U64 => PrimitiveType::U64,
2013 ast::UintTy::U128 => PrimitiveType::U128,
2018 impl From<ast::FloatTy> for PrimitiveType {
2019 fn from(float_ty: ast::FloatTy) -> PrimitiveType {
2021 ast::FloatTy::F32 => PrimitiveType::F32,
2022 ast::FloatTy::F64 => PrimitiveType::F64,
2027 impl From<ty::IntTy> for PrimitiveType {
2028 fn from(int_ty: ty::IntTy) -> PrimitiveType {
2030 ty::IntTy::Isize => PrimitiveType::Isize,
2031 ty::IntTy::I8 => PrimitiveType::I8,
2032 ty::IntTy::I16 => PrimitiveType::I16,
2033 ty::IntTy::I32 => PrimitiveType::I32,
2034 ty::IntTy::I64 => PrimitiveType::I64,
2035 ty::IntTy::I128 => PrimitiveType::I128,
2040 impl From<ty::UintTy> for PrimitiveType {
2041 fn from(uint_ty: ty::UintTy) -> PrimitiveType {
2043 ty::UintTy::Usize => PrimitiveType::Usize,
2044 ty::UintTy::U8 => PrimitiveType::U8,
2045 ty::UintTy::U16 => PrimitiveType::U16,
2046 ty::UintTy::U32 => PrimitiveType::U32,
2047 ty::UintTy::U64 => PrimitiveType::U64,
2048 ty::UintTy::U128 => PrimitiveType::U128,
2053 impl From<ty::FloatTy> for PrimitiveType {
2054 fn from(float_ty: ty::FloatTy) -> PrimitiveType {
2056 ty::FloatTy::F32 => PrimitiveType::F32,
2057 ty::FloatTy::F64 => PrimitiveType::F64,
2062 impl From<hir::PrimTy> for PrimitiveType {
2063 fn from(prim_ty: hir::PrimTy) -> PrimitiveType {
2065 hir::PrimTy::Int(int_ty) => int_ty.into(),
2066 hir::PrimTy::Uint(uint_ty) => uint_ty.into(),
2067 hir::PrimTy::Float(float_ty) => float_ty.into(),
2068 hir::PrimTy::Str => PrimitiveType::Str,
2069 hir::PrimTy::Bool => PrimitiveType::Bool,
2070 hir::PrimTy::Char => PrimitiveType::Char,
2075 #[derive(Clone, Debug)]
2076 pub(crate) struct Struct {
2077 pub(crate) ctor_kind: Option<CtorKind>,
2078 pub(crate) generics: Generics,
2079 pub(crate) fields: Vec<Item>,
2083 pub(crate) fn has_stripped_entries(&self) -> bool {
2084 self.fields.iter().any(|f| f.is_stripped())
2088 #[derive(Clone, Debug)]
2089 pub(crate) struct Union {
2090 pub(crate) generics: Generics,
2091 pub(crate) fields: Vec<Item>,
2095 pub(crate) fn has_stripped_entries(&self) -> bool {
2096 self.fields.iter().any(|f| f.is_stripped())
2100 /// This is a more limited form of the standard Struct, different in that
2101 /// it lacks the things most items have (name, id, parameterization). Found
2102 /// only as a variant in an enum.
2103 #[derive(Clone, Debug)]
2104 pub(crate) struct VariantStruct {
2105 pub(crate) fields: Vec<Item>,
2108 impl VariantStruct {
2109 pub(crate) fn has_stripped_entries(&self) -> bool {
2110 self.fields.iter().any(|f| f.is_stripped())
2114 #[derive(Clone, Debug)]
2115 pub(crate) struct Enum {
2116 pub(crate) variants: IndexVec<VariantIdx, Item>,
2117 pub(crate) generics: Generics,
2121 pub(crate) fn has_stripped_entries(&self) -> bool {
2122 self.variants.iter().any(|f| f.is_stripped())
2125 pub(crate) fn variants(&self) -> impl Iterator<Item = &Item> {
2126 self.variants.iter().filter(|v| !v.is_stripped())
2130 #[derive(Clone, Debug)]
2131 pub(crate) struct Variant {
2132 pub kind: VariantKind,
2133 pub discriminant: Option<Discriminant>,
2136 #[derive(Clone, Debug)]
2137 pub(crate) enum VariantKind {
2140 Struct(VariantStruct),
2144 pub(crate) fn has_stripped_entries(&self) -> Option<bool> {
2146 VariantKind::Struct(struct_) => Some(struct_.has_stripped_entries()),
2147 VariantKind::CLike | VariantKind::Tuple(_) => None,
2152 #[derive(Clone, Debug)]
2153 pub(crate) struct Discriminant {
2154 // In the case of cross crate re-exports, we don't have the nessesary information
2155 // to reconstruct the expression of the discriminant, only the value.
2156 pub(super) expr: Option<BodyId>,
2157 pub(super) value: DefId,
2161 /// Will be `None` in the case of cross-crate reexports, and may be
2163 pub(crate) fn expr(&self, tcx: TyCtxt<'_>) -> Option<String> {
2164 self.expr.map(|body| print_const_expr(tcx, body))
2166 /// Will always be a machine readable number, without underscores or suffixes.
2167 pub(crate) fn value(&self, tcx: TyCtxt<'_>) -> String {
2168 print_evaluated_const(tcx, self.value, false).unwrap()
2172 /// Small wrapper around [`rustc_span::Span`] that adds helper methods
2173 /// and enforces calling [`rustc_span::Span::source_callsite()`].
2174 #[derive(Copy, Clone, Debug)]
2175 pub(crate) struct Span(rustc_span::Span);
2178 /// Wraps a [`rustc_span::Span`]. In case this span is the result of a macro expansion, the
2179 /// span will be updated to point to the macro invocation instead of the macro definition.
2181 /// (See rust-lang/rust#39726)
2182 pub(crate) fn new(sp: rustc_span::Span) -> Self {
2183 Self(sp.source_callsite())
2186 pub(crate) fn inner(&self) -> rustc_span::Span {
2190 pub(crate) fn filename(&self, sess: &Session) -> FileName {
2191 sess.source_map().span_to_filename(self.0)
2194 pub(crate) fn lo(&self, sess: &Session) -> Loc {
2195 sess.source_map().lookup_char_pos(self.0.lo())
2198 pub(crate) fn hi(&self, sess: &Session) -> Loc {
2199 sess.source_map().lookup_char_pos(self.0.hi())
2202 pub(crate) fn cnum(&self, sess: &Session) -> CrateNum {
2203 // FIXME: is there a time when the lo and hi crate would be different?
2204 self.lo(sess).file.cnum
2208 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2209 pub(crate) struct Path {
2210 pub(crate) res: Res,
2211 pub(crate) segments: ThinVec<PathSegment>,
2215 pub(crate) fn def_id(&self) -> DefId {
2219 pub(crate) fn last_opt(&self) -> Option<Symbol> {
2220 self.segments.last().map(|s| s.name)
2223 pub(crate) fn last(&self) -> Symbol {
2224 self.last_opt().expect("segments were empty")
2227 pub(crate) fn whole_name(&self) -> String {
2230 .map(|s| if s.name == kw::PathRoot { "" } else { s.name.as_str() })
2235 /// Checks if this is a `T::Name` path for an associated type.
2236 pub(crate) fn is_assoc_ty(&self) -> bool {
2238 Res::SelfTyParam { .. } | Res::SelfTyAlias { .. } | Res::Def(DefKind::TyParam, _)
2239 if self.segments.len() != 1 =>
2243 Res::Def(DefKind::AssocTy, _) => true,
2248 pub(crate) fn generics(&self) -> Option<Vec<&Type>> {
2249 self.segments.last().and_then(|seg| {
2250 if let GenericArgs::AngleBracketed { ref args, .. } = seg.args {
2253 .filter_map(|arg| match arg {
2254 GenericArg::Type(ty) => Some(ty),
2265 pub(crate) fn bindings(&self) -> Option<&[TypeBinding]> {
2266 self.segments.last().and_then(|seg| {
2267 if let GenericArgs::AngleBracketed { ref bindings, .. } = seg.args {
2276 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2277 pub(crate) enum GenericArg {
2280 Const(Box<Constant>),
2284 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2285 pub(crate) enum GenericArgs {
2286 AngleBracketed { args: Box<[GenericArg]>, bindings: ThinVec<TypeBinding> },
2287 Parenthesized { inputs: Box<[Type]>, output: Option<Box<Type>> },
2290 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2291 pub(crate) struct PathSegment {
2292 pub(crate) name: Symbol,
2293 pub(crate) args: GenericArgs,
2296 #[derive(Clone, Debug)]
2297 pub(crate) struct Typedef {
2298 pub(crate) type_: Type,
2299 pub(crate) generics: Generics,
2300 /// `type_` can come from either the HIR or from metadata. If it comes from HIR, it may be a type
2301 /// alias instead of the final type. This will always have the final type, regardless of whether
2302 /// `type_` came from HIR or from metadata.
2304 /// If `item_type.is_none()`, `type_` is guaranteed to come from metadata (and therefore hold the
2306 pub(crate) item_type: Option<Type>,
2309 #[derive(Clone, Debug)]
2310 pub(crate) struct OpaqueTy {
2311 pub(crate) bounds: Vec<GenericBound>,
2312 pub(crate) generics: Generics,
2315 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2316 pub(crate) struct BareFunctionDecl {
2317 pub(crate) unsafety: hir::Unsafety,
2318 pub(crate) generic_params: Vec<GenericParamDef>,
2319 pub(crate) decl: FnDecl,
2320 pub(crate) abi: Abi,
2323 #[derive(Clone, Debug)]
2324 pub(crate) struct Static {
2325 pub(crate) type_: Type,
2326 pub(crate) mutability: Mutability,
2327 pub(crate) expr: Option<BodyId>,
2330 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2331 pub(crate) struct Constant {
2332 pub(crate) type_: Type,
2333 pub(crate) kind: ConstantKind,
2336 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2337 pub(crate) enum Term {
2343 pub(crate) fn ty(&self) -> Option<&Type> {
2344 if let Term::Type(ty) = self { Some(ty) } else { None }
2348 impl From<Type> for Term {
2349 fn from(ty: Type) -> Self {
2354 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2355 pub(crate) enum ConstantKind {
2356 /// This is the wrapper around `ty::Const` for a non-local constant. Because it doesn't have a
2357 /// `BodyId`, we need to handle it on its own.
2359 /// Note that `ty::Const` includes generic parameters, and may not always be uniquely identified
2360 /// by a DefId. So this field must be different from `Extern`.
2361 TyConst { expr: Box<str> },
2362 /// A constant (expression) that's not an item or associated item. These are usually found
2363 /// nested inside types (e.g., array lengths) or expressions (e.g., repeat counts), and also
2364 /// used to define explicit discriminant values for enum variants.
2365 Anonymous { body: BodyId },
2366 /// A constant from a different crate.
2367 Extern { def_id: DefId },
2368 /// `const FOO: u32 = ...;`
2369 Local { def_id: DefId, body: BodyId },
2373 pub(crate) fn expr(&self, tcx: TyCtxt<'_>) -> String {
2377 pub(crate) fn value(&self, tcx: TyCtxt<'_>) -> Option<String> {
2378 self.kind.value(tcx)
2381 pub(crate) fn is_literal(&self, tcx: TyCtxt<'_>) -> bool {
2382 self.kind.is_literal(tcx)
2387 pub(crate) fn expr(&self, tcx: TyCtxt<'_>) -> String {
2389 ConstantKind::TyConst { ref expr } => expr.to_string(),
2390 ConstantKind::Extern { def_id } => print_inlined_const(tcx, def_id),
2391 ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2392 print_const_expr(tcx, body)
2397 pub(crate) fn value(&self, tcx: TyCtxt<'_>) -> Option<String> {
2399 ConstantKind::TyConst { .. } | ConstantKind::Anonymous { .. } => None,
2400 ConstantKind::Extern { def_id } | ConstantKind::Local { def_id, .. } => {
2401 print_evaluated_const(tcx, def_id, true)
2406 pub(crate) fn is_literal(&self, tcx: TyCtxt<'_>) -> bool {
2408 ConstantKind::TyConst { .. } | ConstantKind::Extern { .. } => false,
2409 ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2410 is_literal_expr(tcx, body.hir_id)
2416 #[derive(Clone, Debug)]
2417 pub(crate) struct Impl {
2418 pub(crate) unsafety: hir::Unsafety,
2419 pub(crate) generics: Generics,
2420 pub(crate) trait_: Option<Path>,
2421 pub(crate) for_: Type,
2422 pub(crate) items: Vec<Item>,
2423 pub(crate) polarity: ty::ImplPolarity,
2424 pub(crate) kind: ImplKind,
2428 pub(crate) fn provided_trait_methods(&self, tcx: TyCtxt<'_>) -> FxHashSet<Symbol> {
2431 .map(|t| t.def_id())
2432 .map(|did| tcx.provided_trait_methods(did).map(|meth| meth.name).collect())
2433 .unwrap_or_default()
2437 #[derive(Clone, Debug)]
2438 pub(crate) enum ImplKind {
2446 pub(crate) fn is_auto(&self) -> bool {
2447 matches!(self, ImplKind::Auto)
2450 pub(crate) fn is_blanket(&self) -> bool {
2451 matches!(self, ImplKind::Blanket(_))
2454 pub(crate) fn is_fake_variadic(&self) -> bool {
2455 matches!(self, ImplKind::FakeVaradic)
2458 pub(crate) fn as_blanket_ty(&self) -> Option<&Type> {
2460 ImplKind::Blanket(ty) => Some(ty),
2466 #[derive(Clone, Debug)]
2467 pub(crate) struct Import {
2468 pub(crate) kind: ImportKind,
2469 pub(crate) source: ImportSource,
2470 pub(crate) should_be_displayed: bool,
2474 pub(crate) fn new_simple(
2476 source: ImportSource,
2477 should_be_displayed: bool,
2479 Self { kind: ImportKind::Simple(name), source, should_be_displayed }
2482 pub(crate) fn new_glob(source: ImportSource, should_be_displayed: bool) -> Self {
2483 Self { kind: ImportKind::Glob, source, should_be_displayed }
2486 pub(crate) fn imported_item_is_doc_hidden(&self, tcx: TyCtxt<'_>) -> bool {
2487 self.source.did.map_or(false, |did| tcx.is_doc_hidden(did))
2491 #[derive(Clone, Debug)]
2492 pub(crate) enum ImportKind {
2493 // use source as str;
2499 #[derive(Clone, Debug)]
2500 pub(crate) struct ImportSource {
2501 pub(crate) path: Path,
2502 pub(crate) did: Option<DefId>,
2505 #[derive(Clone, Debug)]
2506 pub(crate) struct Macro {
2507 pub(crate) source: String,
2510 #[derive(Clone, Debug)]
2511 pub(crate) struct ProcMacro {
2512 pub(crate) kind: MacroKind,
2513 pub(crate) helpers: Vec<Symbol>,
2516 /// An type binding on an associated type (e.g., `A = Bar` in `Foo<A = Bar>` or
2517 /// `A: Send + Sync` in `Foo<A: Send + Sync>`).
2518 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2519 pub(crate) struct TypeBinding {
2520 pub(crate) assoc: PathSegment,
2521 pub(crate) kind: TypeBindingKind,
2524 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2525 pub(crate) enum TypeBindingKind {
2526 Equality { term: Term },
2527 Constraint { bounds: Vec<GenericBound> },
2531 pub(crate) fn term(&self) -> &Term {
2533 TypeBindingKind::Equality { ref term } => term,
2534 _ => panic!("expected equality type binding for parenthesized generic args"),
2539 /// The type, lifetime, or constant that a private type alias's parameter should be
2540 /// replaced with when expanding a use of that type alias.
2545 /// type PrivAlias<T> = Vec<T>;
2547 /// pub fn public_fn() -> PrivAlias<i32> { vec![] }
2550 /// `public_fn`'s docs will show it as returning `Vec<i32>`, since `PrivAlias` is private.
2551 /// [`SubstParam`] is used to record that `T` should be mapped to `i32`.
2552 pub(crate) enum SubstParam {
2559 pub(crate) fn as_ty(&self) -> Option<&Type> {
2560 if let Self::Type(ty) = self { Some(ty) } else { None }
2563 pub(crate) fn as_lt(&self) -> Option<&Lifetime> {
2564 if let Self::Lifetime(lt) = self { Some(lt) } else { None }
2568 // Some nodes are used a lot. Make sure they don't unintentionally get bigger.
2569 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2572 use rustc_data_structures::static_assert_size;
2573 // tidy-alphabetical-start
2574 static_assert_size!(Crate, 64); // frequently moved by-value
2575 static_assert_size!(DocFragment, 32);
2576 static_assert_size!(GenericArg, 32);
2577 static_assert_size!(GenericArgs, 32);
2578 static_assert_size!(GenericParamDef, 56);
2579 static_assert_size!(Generics, 16);
2580 static_assert_size!(Item, 56);
2581 static_assert_size!(ItemKind, 64);
2582 static_assert_size!(PathSegment, 40);
2583 static_assert_size!(Type, 32);
2584 // tidy-alphabetical-end