1 use std::cell::RefCell;
2 use std::default::Default;
3 use std::hash::{Hash, Hasher};
4 use std::iter::FromIterator;
5 use std::lazy::SyncOnceCell as OnceCell;
6 use std::path::PathBuf;
11 use arrayvec::ArrayVec;
14 use rustc_ast::util::comments::beautify_doc_string;
15 use rustc_ast::{self as ast, AttrStyle};
16 use rustc_attr::{ConstStability, Deprecation, Stability, StabilityLevel};
17 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
18 use rustc_data_structures::thin_vec::ThinVec;
20 use rustc_hir::def::{CtorKind, DefKind, Res};
21 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
22 use rustc_hir::lang_items::LangItem;
23 use rustc_hir::{BodyId, Mutability};
24 use rustc_index::vec::IndexVec;
25 use rustc_middle::ty::{self, TyCtxt};
26 use rustc_session::Session;
27 use rustc_span::hygiene::MacroKind;
28 use rustc_span::source_map::DUMMY_SP;
29 use rustc_span::symbol::{kw, sym, Ident, Symbol, SymbolStr};
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::types::Type::{QPath, ResolvedPath};
38 use crate::clean::utils::{is_literal_expr, print_const_expr, print_evaluated_const};
39 use crate::clean::Clean;
40 use crate::core::DocContext;
41 use crate::formats::cache::Cache;
42 use crate::formats::item_type::ItemType;
43 use crate::html::render::cache::ExternalLocation;
44 use crate::html::render::Context;
47 use self::ItemKind::*;
51 crate type ItemIdSet = FxHashSet<ItemId>;
53 #[derive(Debug, Clone, PartialEq, Eq, Hash, Copy)]
55 /// A "normal" item that uses a [`DefId`] for identification.
57 /// Identifier that is used for auto traits.
58 Auto { trait_: DefId, for_: DefId },
59 /// Identifier that is used for blanket implementations.
60 Blanket { impl_id: DefId, for_: DefId },
61 /// Identifier for primitive types.
62 Primitive(PrimitiveType, CrateNum),
67 crate fn is_local(self) -> bool {
69 ItemId::Auto { for_: id, .. }
70 | ItemId::Blanket { for_: id, .. }
71 | ItemId::DefId(id) => id.is_local(),
72 ItemId::Primitive(_, krate) => krate == LOCAL_CRATE,
78 crate fn expect_def_id(self) -> DefId {
80 .unwrap_or_else(|| panic!("ItemId::expect_def_id: `{:?}` isn't a DefId", self))
84 crate fn as_def_id(self) -> Option<DefId> {
86 ItemId::DefId(id) => Some(id),
92 crate fn krate(self) -> CrateNum {
94 ItemId::Auto { for_: id, .. }
95 | ItemId::Blanket { for_: id, .. }
96 | ItemId::DefId(id) => id.krate,
97 ItemId::Primitive(_, krate) => krate,
102 crate fn index(self) -> Option<DefIndex> {
104 ItemId::DefId(id) => Some(id.index),
110 impl From<DefId> for ItemId {
111 fn from(id: DefId) -> Self {
116 #[derive(Clone, Debug)]
121 crate externs: Vec<ExternalCrate>,
122 crate primitives: ThinVec<(DefId, PrimitiveType)>,
123 // These are later on moved into `CACHEKEY`, leaving the map empty.
124 // Only here so that they can be filtered through the rustdoc passes.
125 crate external_traits: Rc<RefCell<FxHashMap<DefId, TraitWithExtraInfo>>>,
126 crate collapsed: bool,
129 /// This struct is used to wrap additional information added by rustdoc on a `trait` item.
130 #[derive(Clone, Debug)]
131 crate struct TraitWithExtraInfo {
133 crate is_notable: bool,
136 #[derive(Copy, Clone, Debug)]
137 crate struct ExternalCrate {
138 crate crate_num: CrateNum,
143 crate fn def_id(&self) -> DefId {
144 DefId { krate: self.crate_num, index: CRATE_DEF_INDEX }
147 crate fn src(&self, tcx: TyCtxt<'_>) -> FileName {
148 let krate_span = tcx.def_span(self.def_id());
149 tcx.sess.source_map().span_to_filename(krate_span)
152 crate fn name(&self, tcx: TyCtxt<'_>) -> Symbol {
153 tcx.crate_name(self.crate_num)
156 crate fn src_root(&self, tcx: TyCtxt<'_>) -> PathBuf {
157 match self.src(tcx) {
158 FileName::Real(ref p) => match p.local_path_if_available().parent() {
159 Some(p) => p.to_path_buf(),
160 None => PathBuf::new(),
166 /// Attempts to find where an external crate is located, given that we're
167 /// rendering in to the specified source destination.
170 extern_url: Option<&str>,
171 extern_url_takes_precedence: bool,
172 dst: &std::path::Path,
174 ) -> ExternalLocation {
175 use ExternalLocation::*;
177 fn to_remote(url: impl ToString) -> ExternalLocation {
178 let mut url = url.to_string();
179 if !url.ends_with('/') {
185 // See if there's documentation generated into the local directory
186 // WARNING: since rustdoc creates these directories as it generates documentation, this check is only accurate before rendering starts.
187 // Make sure to call `location()` by that time.
188 let local_location = dst.join(&*self.name(tcx).as_str());
189 if local_location.is_dir() {
193 if extern_url_takes_precedence {
194 if let Some(url) = extern_url {
195 return to_remote(url);
199 // Failing that, see if there's an attribute specifying where to find this
201 let did = DefId { krate: self.crate_num, index: CRATE_DEF_INDEX };
204 .filter(|a| a.has_name(sym::html_root_url))
205 .filter_map(|a| a.value_str())
208 .or(extern_url.map(to_remote)) // NOTE: only matters if `extern_url_takes_precedence` is false
209 .unwrap_or(Unknown) // Well, at least we tried.
212 crate fn keywords(&self, tcx: TyCtxt<'_>) -> ThinVec<(DefId, Symbol)> {
213 let root = self.def_id();
215 let as_keyword = |res: Res| {
216 if let Res::Def(DefKind::Mod, def_id) = res {
217 let attrs = tcx.get_attrs(def_id);
218 let mut keyword = None;
219 for attr in attrs.lists(sym::doc) {
220 if attr.has_name(sym::keyword) {
221 if let Some(v) = attr.value_str() {
227 return keyword.map(|p| (def_id, p));
238 let item = tcx.hir().item(id);
240 hir::ItemKind::Mod(_) => {
241 as_keyword(Res::Def(DefKind::Mod, id.def_id.to_def_id()))
243 hir::ItemKind::Use(ref path, hir::UseKind::Single)
244 if item.vis.node.is_pub() =>
246 as_keyword(path.res).map(|(_, prim)| (id.def_id.to_def_id(), prim))
253 tcx.item_children(root).iter().map(|item| item.res).filter_map(as_keyword).collect()
257 crate fn primitives(&self, tcx: TyCtxt<'_>) -> ThinVec<(DefId, PrimitiveType)> {
258 let root = self.def_id();
260 // Collect all inner modules which are tagged as implementations of
263 // Note that this loop only searches the top-level items of the crate,
264 // and this is intentional. If we were to search the entire crate for an
265 // item tagged with `#[doc(primitive)]` then we would also have to
266 // search the entirety of external modules for items tagged
267 // `#[doc(primitive)]`, which is a pretty inefficient process (decoding
268 // all that metadata unconditionally).
270 // In order to keep the metadata load under control, the
271 // `#[doc(primitive)]` feature is explicitly designed to only allow the
272 // primitive tags to show up as the top level items in a crate.
274 // Also note that this does not attempt to deal with modules tagged
275 // duplicately for the same primitive. This is handled later on when
276 // rendering by delegating everything to a hash map.
277 let as_primitive = |res: Res| {
278 if let Res::Def(DefKind::Mod, def_id) = res {
279 let attrs = tcx.get_attrs(def_id);
281 for attr in attrs.lists(sym::doc) {
282 if let Some(v) = attr.value_str() {
283 if attr.has_name(sym::primitive) {
284 prim = PrimitiveType::from_symbol(v);
288 // FIXME: should warn on unknown primitives?
292 return prim.map(|p| (def_id, p));
304 let item = tcx.hir().item(id);
306 hir::ItemKind::Mod(_) => {
307 as_primitive(Res::Def(DefKind::Mod, id.def_id.to_def_id()))
309 hir::ItemKind::Use(ref path, hir::UseKind::Single)
310 if item.vis.node.is_pub() =>
312 as_primitive(path.res).map(|(_, prim)| {
313 // Pretend the primitive is local.
314 (id.def_id.to_def_id(), prim)
322 tcx.item_children(root).iter().map(|item| item.res).filter_map(as_primitive).collect()
327 /// Anything with a source location and set of attributes and, optionally, a
328 /// name. That is, anything that can be documented. This doesn't correspond
329 /// directly to the AST's concept of an item; it's a strict superset.
330 #[derive(Clone, Debug)]
332 /// The name of this item.
333 /// Optional because not every item has a name, e.g. impls.
334 crate name: Option<Symbol>,
335 crate attrs: Box<Attributes>,
336 crate visibility: Visibility,
337 /// Information about this item that is specific to what kind of item it is.
338 /// E.g., struct vs enum vs function.
339 crate kind: Box<ItemKind>,
340 crate def_id: ItemId,
342 crate cfg: Option<Arc<Cfg>>,
345 // `Item` is used a lot. Make sure it doesn't unintentionally get bigger.
346 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
347 rustc_data_structures::static_assert_size!(Item, 56);
349 crate fn rustc_span(def_id: DefId, tcx: TyCtxt<'_>) -> Span {
350 Span::new(def_id.as_local().map_or_else(
351 || tcx.def_span(def_id),
354 hir.span_with_body(hir.local_def_id_to_hir_id(local))
360 crate fn stability<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Option<&'tcx Stability> {
361 self.def_id.as_def_id().and_then(|did| tcx.lookup_stability(did))
364 crate fn const_stability<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Option<&'tcx ConstStability> {
365 self.def_id.as_def_id().and_then(|did| tcx.lookup_const_stability(did))
368 crate fn deprecation(&self, tcx: TyCtxt<'_>) -> Option<Deprecation> {
369 self.def_id.as_def_id().and_then(|did| tcx.lookup_deprecation(did))
372 crate fn inner_docs(&self, tcx: TyCtxt<'_>) -> bool {
373 self.def_id.as_def_id().map(|did| tcx.get_attrs(did).inner_docs()).unwrap_or(false)
376 crate fn span(&self, tcx: TyCtxt<'_>) -> Span {
377 let kind = match &*self.kind {
378 ItemKind::StrippedItem(k) => k,
381 if let ItemKind::ModuleItem(Module { span, .. }) | ItemKind::ImplItem(Impl { span, .. }) =
386 self.def_id.as_def_id().map(|did| rustc_span(did, tcx)).unwrap_or_else(|| Span::dummy())
390 crate fn attr_span(&self, tcx: TyCtxt<'_>) -> rustc_span::Span {
391 crate::passes::span_of_attrs(&self.attrs).unwrap_or_else(|| self.span(tcx).inner())
394 /// Finds the `doc` attribute as a NameValue and returns the corresponding
396 crate fn doc_value(&self) -> Option<String> {
397 self.attrs.doc_value()
400 /// Convenience wrapper around [`Self::from_def_id_and_parts`] which converts
401 /// `hir_id` to a [`DefId`]
402 pub fn from_hir_id_and_parts(
404 name: Option<Symbol>,
406 cx: &mut DocContext<'_>,
408 Item::from_def_id_and_parts(cx.tcx.hir().local_def_id(hir_id).to_def_id(), name, kind, cx)
411 pub fn from_def_id_and_parts(
413 name: Option<Symbol>,
415 cx: &mut DocContext<'_>,
417 let ast_attrs = cx.tcx.get_attrs(def_id);
419 Self::from_def_id_and_attrs_and_parts(
423 Box::new(ast_attrs.clean(cx)),
425 ast_attrs.cfg(cx.sess()),
429 pub fn from_def_id_and_attrs_and_parts(
431 name: Option<Symbol>,
433 attrs: Box<Attributes>,
434 cx: &mut DocContext<'_>,
435 cfg: Option<Arc<Cfg>>,
437 trace!("name={:?}, def_id={:?}", name, def_id);
440 def_id: def_id.into(),
441 kind: Box::new(kind),
444 visibility: cx.tcx.visibility(def_id).clean(cx),
449 /// Finds all `doc` attributes as NameValues and returns their corresponding values, joined
451 crate fn collapsed_doc_value(&self) -> Option<String> {
452 self.attrs.collapsed_doc_value()
455 crate fn links(&self, cx: &Context<'_>) -> Vec<RenderedLink> {
456 use crate::html::format::href;
461 .map_or(&[][..], |v| v.as_slice())
463 .filter_map(|ItemLink { link: s, link_text, did, ref fragment }| {
466 if let Ok((mut href, ..)) = href(did.clone(), cx) {
467 if let Some(ref fragment) = *fragment {
469 href.push_str(fragment);
472 original_text: s.clone(),
473 new_text: link_text.clone(),
480 // FIXME(83083): using fragments as a side-channel for
481 // primitive names is very unfortunate
483 let relative_to = &cx.current;
484 if let Some(ref fragment) = *fragment {
485 let url = match cx.cache().extern_locations.get(&self.def_id.krate()) {
486 Some(&ExternalLocation::Local) => {
487 if relative_to[0] == "std" {
488 let depth = relative_to.len() - 1;
491 let depth = relative_to.len();
492 format!("{}std/", "../".repeat(depth))
495 Some(ExternalLocation::Remote(ref s)) => {
496 format!("{}/std/", s.trim_end_matches('/'))
498 Some(ExternalLocation::Unknown) | None => {
499 format!("{}/std/", crate::DOC_RUST_LANG_ORG_CHANNEL)
502 // This is a primitive so the url is done "by hand".
503 let tail = fragment.find('#').unwrap_or_else(|| fragment.len());
505 original_text: s.clone(),
506 new_text: link_text.clone(),
508 "{}primitive.{}.html{}",
515 panic!("This isn't a primitive?!");
523 /// Find a list of all link names, without finding their href.
525 /// This is used for generating summary text, which does not include
526 /// the link text, but does need to know which `[]`-bracketed names
527 /// are actually links.
528 crate fn link_names(&self, cache: &Cache) -> Vec<RenderedLink> {
532 .map_or(&[][..], |v| v.as_slice())
534 .filter_map(|ItemLink { link: s, link_text, did, fragment }| {
535 // FIXME(83083): using fragments as a side-channel for
536 // primitive names is very unfortunate
537 if did.is_some() || fragment.is_some() {
539 original_text: s.clone(),
540 new_text: link_text.clone(),
550 crate fn is_crate(&self) -> bool {
551 self.is_mod() && self.def_id.as_def_id().map_or(false, |did| did.index == CRATE_DEF_INDEX)
553 crate fn is_mod(&self) -> bool {
554 self.type_() == ItemType::Module
556 crate fn is_trait(&self) -> bool {
557 self.type_() == ItemType::Trait
559 crate fn is_struct(&self) -> bool {
560 self.type_() == ItemType::Struct
562 crate fn is_enum(&self) -> bool {
563 self.type_() == ItemType::Enum
565 crate fn is_variant(&self) -> bool {
566 self.type_() == ItemType::Variant
568 crate fn is_associated_type(&self) -> bool {
569 self.type_() == ItemType::AssocType
571 crate fn is_associated_const(&self) -> bool {
572 self.type_() == ItemType::AssocConst
574 crate fn is_method(&self) -> bool {
575 self.type_() == ItemType::Method
577 crate fn is_ty_method(&self) -> bool {
578 self.type_() == ItemType::TyMethod
580 crate fn is_typedef(&self) -> bool {
581 self.type_() == ItemType::Typedef
583 crate fn is_primitive(&self) -> bool {
584 self.type_() == ItemType::Primitive
586 crate fn is_union(&self) -> bool {
587 self.type_() == ItemType::Union
589 crate fn is_import(&self) -> bool {
590 self.type_() == ItemType::Import
592 crate fn is_extern_crate(&self) -> bool {
593 self.type_() == ItemType::ExternCrate
595 crate fn is_keyword(&self) -> bool {
596 self.type_() == ItemType::Keyword
598 crate fn is_stripped(&self) -> bool {
600 StrippedItem(..) => true,
601 ImportItem(ref i) => !i.should_be_displayed,
605 crate fn has_stripped_fields(&self) -> Option<bool> {
607 StructItem(ref _struct) => Some(_struct.fields_stripped),
608 UnionItem(ref union) => Some(union.fields_stripped),
609 VariantItem(Variant::Struct(ref vstruct)) => Some(vstruct.fields_stripped),
614 crate fn stability_class(&self, tcx: TyCtxt<'_>) -> Option<String> {
615 self.stability(tcx).as_ref().and_then(|ref s| {
616 let mut classes = Vec::with_capacity(2);
618 if s.level.is_unstable() {
619 classes.push("unstable");
622 // FIXME: what about non-staged API items that are deprecated?
623 if self.deprecation(tcx).is_some() {
624 classes.push("deprecated");
627 if !classes.is_empty() { Some(classes.join(" ")) } else { None }
631 crate fn stable_since(&self, tcx: TyCtxt<'_>) -> Option<SymbolStr> {
632 match self.stability(tcx)?.level {
633 StabilityLevel::Stable { since, .. } => Some(since.as_str()),
634 StabilityLevel::Unstable { .. } => None,
638 crate fn const_stable_since(&self, tcx: TyCtxt<'_>) -> Option<SymbolStr> {
639 match self.const_stability(tcx)?.level {
640 StabilityLevel::Stable { since, .. } => Some(since.as_str()),
641 StabilityLevel::Unstable { .. } => None,
645 crate fn is_non_exhaustive(&self) -> bool {
646 self.attrs.other_attrs.iter().any(|a| a.has_name(sym::non_exhaustive))
649 /// Returns a documentation-level item type from the item.
650 crate fn type_(&self) -> ItemType {
654 crate fn is_default(&self) -> bool {
656 ItemKind::MethodItem(_, Some(defaultness)) => {
657 defaultness.has_value() && !defaultness.is_final()
664 #[derive(Clone, Debug)]
665 crate enum ItemKind {
667 /// The crate's name, *not* the name it's imported as.
674 FunctionItem(Function),
676 TypedefItem(Typedef, bool /* is associated type */),
677 OpaqueTyItem(OpaqueTy),
679 ConstantItem(Constant),
681 TraitAliasItem(TraitAlias),
683 /// A method signature only. Used for required methods in traits (ie,
684 /// non-default-methods).
685 TyMethodItem(Function),
686 /// A method with a body.
687 MethodItem(Function, Option<hir::Defaultness>),
688 StructFieldItem(Type),
689 VariantItem(Variant),
690 /// `fn`s from an extern block
691 ForeignFunctionItem(Function),
692 /// `static`s from an extern block
693 ForeignStaticItem(Static),
694 /// `type`s from an extern block
697 ProcMacroItem(ProcMacro),
698 PrimitiveItem(PrimitiveType),
699 AssocConstItem(Type, Option<String>),
700 /// An associated item in a trait or trait impl.
702 /// The bounds may be non-empty if there is a `where` clause.
703 /// The `Option<Type>` is the default concrete type (e.g. `trait Trait { type Target = usize; }`)
704 AssocTypeItem(Vec<GenericBound>, Option<Type>),
705 /// An item that has been stripped by a rustdoc pass
706 StrippedItem(Box<ItemKind>),
711 /// Some items contain others such as structs (for their fields) and Enums
712 /// (for their variants). This method returns those contained items.
713 crate fn inner_items(&self) -> impl Iterator<Item = &Item> {
715 StructItem(s) => s.fields.iter(),
716 UnionItem(u) => u.fields.iter(),
717 VariantItem(Variant::Struct(v)) => v.fields.iter(),
718 VariantItem(Variant::Tuple(v)) => v.iter(),
719 EnumItem(e) => e.variants.iter(),
720 TraitItem(t) => t.items.iter(),
721 ImplItem(i) => i.items.iter(),
722 ModuleItem(m) => m.items.iter(),
723 ExternCrateItem { .. }
735 | ForeignFunctionItem(_)
736 | ForeignStaticItem(_)
741 | AssocConstItem(_, _)
742 | AssocTypeItem(_, _)
744 | KeywordItem(_) => [].iter(),
749 #[derive(Clone, Debug)]
750 crate struct Module {
751 crate items: Vec<Item>,
755 crate struct ListAttributesIter<'a> {
756 attrs: slice::Iter<'a, ast::Attribute>,
757 current_list: vec::IntoIter<ast::NestedMetaItem>,
761 impl<'a> Iterator for ListAttributesIter<'a> {
762 type Item = ast::NestedMetaItem;
764 fn next(&mut self) -> Option<Self::Item> {
765 if let Some(nested) = self.current_list.next() {
769 for attr in &mut self.attrs {
770 if let Some(list) = attr.meta_item_list() {
771 if attr.has_name(self.name) {
772 self.current_list = list.into_iter();
773 if let Some(nested) = self.current_list.next() {
783 fn size_hint(&self) -> (usize, Option<usize>) {
784 let lower = self.current_list.len();
789 crate trait AttributesExt {
790 /// Finds an attribute as List and returns the list of attributes nested inside.
791 fn lists(&self, name: Symbol) -> ListAttributesIter<'_>;
793 fn span(&self) -> Option<rustc_span::Span>;
795 fn inner_docs(&self) -> bool;
797 fn other_attrs(&self) -> Vec<ast::Attribute>;
799 fn cfg(&self, sess: &Session) -> Option<Arc<Cfg>>;
802 impl AttributesExt for [ast::Attribute] {
803 fn lists(&self, name: Symbol) -> ListAttributesIter<'_> {
804 ListAttributesIter { attrs: self.iter(), current_list: Vec::new().into_iter(), name }
807 /// Return the span of the first doc-comment, if it exists.
808 fn span(&self) -> Option<rustc_span::Span> {
809 self.iter().find(|attr| attr.doc_str().is_some()).map(|attr| attr.span)
812 /// Returns whether the first doc-comment is an inner attribute.
814 //// If there are no doc-comments, return true.
815 /// FIXME(#78591): Support both inner and outer attributes on the same item.
816 fn inner_docs(&self) -> bool {
817 self.iter().find(|a| a.doc_str().is_some()).map_or(true, |a| a.style == AttrStyle::Inner)
820 fn other_attrs(&self) -> Vec<ast::Attribute> {
821 self.iter().filter(|attr| attr.doc_str().is_none()).cloned().collect()
824 fn cfg(&self, sess: &Session) -> Option<Arc<Cfg>> {
825 let mut cfg = Cfg::True;
827 for attr in self.iter() {
829 if attr.doc_str().is_none() && attr.has_name(sym::doc) {
831 if let Some(list) = attr.meta().as_ref().and_then(|mi| mi.meta_item_list()) {
834 if !item.has_name(sym::cfg) {
838 if let Some(cfg_mi) = item
840 .and_then(|item| rustc_expand::config::parse_cfg(&item, sess))
842 match Cfg::parse(&cfg_mi) {
843 Ok(new_cfg) => cfg &= new_cfg,
844 Err(e) => sess.span_err(e.span, e.msg),
852 for attr in self.lists(sym::target_feature) {
853 if attr.has_name(sym::enable) {
854 if let Some(feat) = attr.value_str() {
855 let meta = attr::mk_name_value_item_str(
856 Ident::with_dummy_span(sym::target_feature),
860 if let Ok(feat_cfg) = Cfg::parse(&meta) {
867 if cfg == Cfg::True { None } else { Some(Arc::new(cfg)) }
871 crate trait NestedAttributesExt {
872 /// Returns `true` if the attribute list contains a specific `Word`
873 fn has_word(self, word: Symbol) -> bool;
874 fn get_word_attr(self, word: Symbol) -> Option<ast::NestedMetaItem>;
877 impl<I: Iterator<Item = ast::NestedMetaItem> + IntoIterator<Item = ast::NestedMetaItem>>
878 NestedAttributesExt for I
880 fn has_word(self, word: Symbol) -> bool {
881 self.into_iter().any(|attr| attr.is_word() && attr.has_name(word))
884 fn get_word_attr(mut self, word: Symbol) -> Option<ast::NestedMetaItem> {
885 self.find(|attr| attr.is_word() && attr.has_name(word))
889 /// A portion of documentation, extracted from a `#[doc]` attribute.
891 /// Each variant contains the line number within the complete doc-comment where the fragment
892 /// starts, as well as the Span where the corresponding doc comment or attribute is located.
894 /// Included files are kept separate from inline doc comments so that proper line-number
895 /// information can be given when a doctest fails. Sugared doc comments and "raw" doc comments are
896 /// kept separate because of issue #42760.
897 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
898 crate struct DocFragment {
900 crate span: rustc_span::Span,
901 /// The module this doc-comment came from.
903 /// This allows distinguishing between the original documentation and a pub re-export.
904 /// If it is `None`, the item was not re-exported.
905 crate parent_module: Option<DefId>,
907 crate kind: DocFragmentKind,
908 crate need_backline: bool,
912 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
913 crate enum DocFragmentKind {
914 /// A doc fragment created from a `///` or `//!` doc comment.
916 /// A doc fragment created from a "raw" `#[doc=""]` attribute.
920 // The goal of this function is to apply the `DocFragment` transformations that are required when
921 // transforming into the final markdown. So the transformations in here are:
923 // * Applying the computed indent to each lines in each doc fragment (a `DocFragment` can contain
924 // multiple lines in case of `#[doc = ""]`).
925 // * Adding backlines between `DocFragment`s and adding an extra one if required (stored in the
926 // `need_backline` field).
927 fn add_doc_fragment(out: &mut String, frag: &DocFragment) {
928 let s = frag.doc.as_str();
929 let mut iter = s.lines().peekable();
930 while let Some(line) = iter.next() {
931 if line.chars().any(|c| !c.is_whitespace()) {
932 assert!(line.len() >= frag.indent);
933 out.push_str(&line[frag.indent..]);
937 if iter.peek().is_some() {
941 if frag.need_backline {
946 impl<'a> FromIterator<&'a DocFragment> for String {
947 fn from_iter<T>(iter: T) -> Self
949 T: IntoIterator<Item = &'a DocFragment>,
951 iter.into_iter().fold(String::new(), |mut acc, frag| {
952 add_doc_fragment(&mut acc, &frag);
958 /// The attributes on an [`Item`], including attributes like `#[derive(...)]` and `#[inline]`,
959 /// as well as doc comments.
960 #[derive(Clone, Debug, Default)]
961 crate struct Attributes {
962 crate doc_strings: Vec<DocFragment>,
963 crate other_attrs: Vec<ast::Attribute>,
966 #[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
967 /// A link that has not yet been rendered.
969 /// This link will be turned into a rendered link by [`Item::links`].
970 crate struct ItemLink {
971 /// The original link written in the markdown
972 pub(crate) link: String,
973 /// The link text displayed in the HTML.
975 /// This may not be the same as `link` if there was a disambiguator
976 /// in an intra-doc link (e.g. \[`fn@f`\])
977 pub(crate) link_text: String,
978 pub(crate) did: Option<DefId>,
979 /// The url fragment to append to the link
980 pub(crate) fragment: Option<String>,
983 pub struct RenderedLink {
984 /// The text the link was original written as.
986 /// This could potentially include disambiguators and backticks.
987 pub(crate) original_text: String,
988 /// The text to display in the HTML
989 pub(crate) new_text: String,
990 /// The URL to put in the `href`
991 pub(crate) href: String,
995 crate fn lists(&self, name: Symbol) -> ListAttributesIter<'_> {
996 self.other_attrs.lists(name)
999 crate fn has_doc_flag(&self, flag: Symbol) -> bool {
1000 for attr in &self.other_attrs {
1001 if !attr.has_name(sym::doc) {
1005 if let Some(items) = attr.meta_item_list() {
1006 if items.iter().filter_map(|i| i.meta_item()).any(|it| it.has_name(flag)) {
1016 attrs: &[ast::Attribute],
1017 additional_attrs: Option<(&[ast::Attribute], DefId)>,
1019 let mut doc_strings: Vec<DocFragment> = vec![];
1020 let mut doc_line = 0;
1022 fn update_need_backline(doc_strings: &mut Vec<DocFragment>) {
1023 if let Some(prev) = doc_strings.last_mut() {
1024 prev.need_backline = true;
1028 let clean_attr = |(attr, parent_module): (&ast::Attribute, Option<DefId>)| {
1029 if let Some(value) = attr.doc_str() {
1030 trace!("got doc_str={:?}", value);
1031 let value = beautify_doc_string(value);
1032 let kind = if attr.is_doc_comment() {
1033 DocFragmentKind::SugaredDoc
1035 DocFragmentKind::RawDoc
1038 let line = doc_line;
1039 doc_line += value.as_str().lines().count();
1040 let frag = DocFragment {
1046 need_backline: false,
1050 update_need_backline(&mut doc_strings);
1052 doc_strings.push(frag);
1060 // Additional documentation should be shown before the original documentation
1061 let other_attrs = additional_attrs
1063 .map(|(attrs, id)| attrs.iter().map(move |attr| (attr, Some(id))))
1065 .chain(attrs.iter().map(|attr| (attr, None)))
1066 .filter_map(clean_attr)
1069 Attributes { doc_strings, other_attrs }
1072 /// Finds the `doc` attribute as a NameValue and returns the corresponding
1074 crate fn doc_value(&self) -> Option<String> {
1075 let mut iter = self.doc_strings.iter();
1077 let ori = iter.next()?;
1078 let mut out = String::new();
1079 add_doc_fragment(&mut out, &ori);
1080 while let Some(new_frag) = iter.next() {
1081 if new_frag.kind != ori.kind || new_frag.parent_module != ori.parent_module {
1084 add_doc_fragment(&mut out, &new_frag);
1086 if out.is_empty() { None } else { Some(out) }
1089 /// Return the doc-comments on this item, grouped by the module they came from.
1091 /// The module can be different if this is a re-export with added documentation.
1092 crate fn collapsed_doc_value_by_module_level(&self) -> FxHashMap<Option<DefId>, String> {
1093 let mut ret = FxHashMap::default();
1095 for new_frag in self.doc_strings.iter() {
1096 let out = ret.entry(new_frag.parent_module).or_default();
1097 add_doc_fragment(out, &new_frag);
1102 /// Finds all `doc` attributes as NameValues and returns their corresponding values, joined
1104 crate fn collapsed_doc_value(&self) -> Option<String> {
1105 if self.doc_strings.is_empty() { None } else { Some(self.doc_strings.iter().collect()) }
1108 crate fn get_doc_aliases(&self) -> Box<[String]> {
1109 let mut aliases = FxHashSet::default();
1111 for attr in self.other_attrs.lists(sym::doc).filter(|a| a.has_name(sym::alias)) {
1112 if let Some(values) = attr.meta_item_list() {
1114 match l.literal().unwrap().kind {
1115 ast::LitKind::Str(s, _) => {
1116 aliases.insert(s.as_str().to_string());
1118 _ => unreachable!(),
1122 aliases.insert(attr.value_str().map(|s| s.to_string()).unwrap());
1125 aliases.into_iter().collect::<Vec<String>>().into()
1129 impl PartialEq for Attributes {
1130 fn eq(&self, rhs: &Self) -> bool {
1131 self.doc_strings == rhs.doc_strings
1135 .map(|attr| attr.id)
1136 .eq(rhs.other_attrs.iter().map(|attr| attr.id))
1140 impl Eq for Attributes {}
1142 impl Hash for Attributes {
1143 fn hash<H: Hasher>(&self, hasher: &mut H) {
1144 self.doc_strings.hash(hasher);
1145 for attr in &self.other_attrs {
1146 attr.id.hash(hasher);
1151 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1152 crate enum GenericBound {
1153 TraitBound(PolyTrait, hir::TraitBoundModifier),
1158 crate fn maybe_sized(cx: &mut DocContext<'_>) -> GenericBound {
1159 let did = cx.tcx.require_lang_item(LangItem::Sized, None);
1160 let empty = cx.tcx.intern_substs(&[]);
1161 let path = external_path(cx, did, false, vec![], empty);
1162 inline::record_extern_fqn(cx, did, ItemType::Trait);
1163 GenericBound::TraitBound(
1165 trait_: ResolvedPath { path, did, is_generic: false },
1166 generic_params: Vec::new(),
1168 hir::TraitBoundModifier::Maybe,
1172 crate fn is_sized_bound(&self, cx: &DocContext<'_>) -> bool {
1173 use rustc_hir::TraitBoundModifier as TBM;
1174 if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, TBM::None) = *self {
1175 if trait_.def_id() == cx.tcx.lang_items().sized_trait() {
1182 crate fn get_poly_trait(&self) -> Option<PolyTrait> {
1183 if let GenericBound::TraitBound(ref p, _) = *self {
1184 return Some(p.clone());
1189 crate fn get_trait_type(&self) -> Option<Type> {
1190 if let GenericBound::TraitBound(PolyTrait { ref trait_, .. }, _) = *self {
1191 Some(trait_.clone())
1198 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1199 crate struct Lifetime(pub Symbol);
1202 crate fn get_ref(&self) -> SymbolStr {
1206 crate fn statik() -> Lifetime {
1207 Lifetime(kw::StaticLifetime)
1210 crate fn elided() -> Lifetime {
1211 Lifetime(kw::UnderscoreLifetime)
1215 #[derive(Clone, Debug)]
1216 crate enum WherePredicate {
1217 BoundPredicate { ty: Type, bounds: Vec<GenericBound>, bound_params: Vec<Lifetime> },
1218 RegionPredicate { lifetime: Lifetime, bounds: Vec<GenericBound> },
1219 EqPredicate { lhs: Type, rhs: Type },
1222 impl WherePredicate {
1223 crate fn get_bounds(&self) -> Option<&[GenericBound]> {
1225 WherePredicate::BoundPredicate { ref bounds, .. } => Some(bounds),
1226 WherePredicate::RegionPredicate { ref bounds, .. } => Some(bounds),
1232 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1233 crate enum GenericParamDefKind {
1235 outlives: Vec<Lifetime>,
1239 bounds: Vec<GenericBound>,
1240 default: Option<Type>,
1241 synthetic: Option<hir::SyntheticTyParamKind>,
1246 default: Option<String>,
1250 impl GenericParamDefKind {
1251 crate fn is_type(&self) -> bool {
1252 matches!(self, GenericParamDefKind::Type { .. })
1255 // FIXME(eddyb) this either returns the default of a type parameter, or the
1256 // type of a `const` parameter. It seems that the intention is to *visit*
1257 // any embedded types, but `get_type` seems to be the wrong name for that.
1258 crate fn get_type(&self) -> Option<Type> {
1260 GenericParamDefKind::Type { default, .. } => default.clone(),
1261 GenericParamDefKind::Const { ty, .. } => Some(ty.clone()),
1262 GenericParamDefKind::Lifetime { .. } => None,
1267 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1268 crate struct GenericParamDef {
1270 crate kind: GenericParamDefKind,
1273 impl GenericParamDef {
1274 crate fn is_synthetic_type_param(&self) -> bool {
1276 GenericParamDefKind::Lifetime { .. } | GenericParamDefKind::Const { .. } => false,
1277 GenericParamDefKind::Type { ref synthetic, .. } => synthetic.is_some(),
1281 crate fn is_type(&self) -> bool {
1285 crate fn get_type(&self) -> Option<Type> {
1286 self.kind.get_type()
1289 crate fn get_bounds(&self) -> Option<&[GenericBound]> {
1291 GenericParamDefKind::Type { ref bounds, .. } => Some(bounds),
1297 // maybe use a Generic enum and use Vec<Generic>?
1298 #[derive(Clone, Debug, Default)]
1299 crate struct Generics {
1300 crate params: Vec<GenericParamDef>,
1301 crate where_predicates: Vec<WherePredicate>,
1304 #[derive(Clone, Debug)]
1305 crate struct Function {
1307 crate generics: Generics,
1308 crate header: hir::FnHeader,
1311 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1312 crate struct FnDecl {
1313 crate inputs: Arguments,
1314 crate output: FnRetTy,
1315 crate c_variadic: bool,
1319 crate fn self_type(&self) -> Option<SelfTy> {
1320 self.inputs.values.get(0).and_then(|v| v.to_self())
1323 /// Returns the sugared return type for an async function.
1325 /// For example, if the return type is `impl std::future::Future<Output = i32>`, this function
1326 /// will return `i32`.
1330 /// This function will panic if the return type does not match the expected sugaring for async
1332 crate fn sugared_async_return_type(&self) -> FnRetTy {
1333 match &self.output {
1334 FnRetTy::Return(Type::ImplTrait(bounds)) => match &bounds[0] {
1335 GenericBound::TraitBound(PolyTrait { trait_, .. }, ..) => {
1336 let bindings = trait_.bindings().unwrap();
1337 FnRetTy::Return(bindings[0].ty().clone())
1339 _ => panic!("unexpected desugaring of async function"),
1341 _ => panic!("unexpected desugaring of async function"),
1346 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1347 crate struct Arguments {
1348 crate values: Vec<Argument>,
1351 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1352 crate struct Argument {
1357 #[derive(Clone, PartialEq, Debug)]
1360 SelfBorrowed(Option<Lifetime>, Mutability),
1365 crate fn to_self(&self) -> Option<SelfTy> {
1366 if self.name != kw::SelfLower {
1369 if self.type_.is_self_type() {
1370 return Some(SelfValue);
1373 BorrowedRef { ref lifetime, mutability, ref type_ } if type_.is_self_type() => {
1374 Some(SelfBorrowed(lifetime.clone(), mutability))
1376 _ => Some(SelfExplicit(self.type_.clone())),
1381 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1382 crate enum FnRetTy {
1387 impl GetDefId for FnRetTy {
1388 fn def_id(&self) -> Option<DefId> {
1390 Return(ref ty) => ty.def_id(),
1391 DefaultReturn => None,
1395 fn def_id_full(&self, cache: &Cache) -> Option<DefId> {
1397 Return(ref ty) => ty.def_id_full(cache),
1398 DefaultReturn => None,
1403 #[derive(Clone, Debug)]
1404 crate struct Trait {
1405 crate unsafety: hir::Unsafety,
1406 crate items: Vec<Item>,
1407 crate generics: Generics,
1408 crate bounds: Vec<GenericBound>,
1409 crate is_auto: bool,
1412 #[derive(Clone, Debug)]
1413 crate struct TraitAlias {
1414 crate generics: Generics,
1415 crate bounds: Vec<GenericBound>,
1418 /// A trait reference, which may have higher ranked lifetimes.
1419 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1420 crate struct PolyTrait {
1422 crate generic_params: Vec<GenericParamDef>,
1425 /// A representation of a type suitable for hyperlinking purposes. Ideally, one can get the original
1426 /// type out of the AST/`TyCtxt` given one of these, if more information is needed. Most
1427 /// importantly, it does not preserve mutability or boxes.
1428 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1430 /// Structs/enums/traits (most that would be an `hir::TyKind::Path`).
1434 /// `true` if is a `T::Name` path for associated types.
1437 /// `dyn for<'a> Trait<'a> + Send + 'static`
1438 DynTrait(Vec<PolyTrait>, Option<Lifetime>),
1439 /// For parameterized types, so the consumer of the JSON don't go
1440 /// looking for types which don't exist anywhere.
1442 /// Primitives are the fixed-size numeric types (plus int/usize/float), char,
1443 /// arrays, slices, and tuples.
1444 Primitive(PrimitiveType),
1445 /// `extern "ABI" fn`
1446 BareFunction(Box<BareFunctionDecl>),
1449 /// The `String` field is about the size or the constant representing the array's length.
1450 Array(Box<Type>, String),
1452 RawPointer(Mutability, Box<Type>),
1454 lifetime: Option<Lifetime>,
1455 mutability: Mutability,
1459 // `<Type as Trait>::Name`
1462 self_type: Box<Type>,
1463 self_def_id: Option<DefId>,
1470 // `impl TraitA + TraitB + ...`
1471 ImplTrait(Vec<GenericBound>),
1474 #[derive(Clone, PartialEq, Eq, Hash, Copy, Debug)]
1475 /// N.B. this has to be different from `hir::PrimTy` because it also includes types that aren't
1476 /// paths, like `Unit`.
1477 crate enum PrimitiveType {
1505 crate trait GetDefId {
1506 /// Use this method to get the [`DefId`] of a [`clean`] AST node.
1507 /// This will return [`None`] when called on a primitive [`clean::Type`].
1508 /// Use [`Self::def_id_full`] if you want to include primitives.
1510 /// [`clean`]: crate::clean
1511 /// [`clean::Type`]: crate::clean::Type
1512 // FIXME: get rid of this function and always use `def_id_full`
1513 fn def_id(&self) -> Option<DefId>;
1515 /// Use this method to get the [DefId] of a [clean] AST node, including [PrimitiveType]s.
1517 /// See [`Self::def_id`] for more.
1519 /// [clean]: crate::clean
1520 fn def_id_full(&self, cache: &Cache) -> Option<DefId>;
1523 impl<T: GetDefId> GetDefId for Option<T> {
1524 fn def_id(&self) -> Option<DefId> {
1525 self.as_ref().and_then(|d| d.def_id())
1528 fn def_id_full(&self, cache: &Cache) -> Option<DefId> {
1529 self.as_ref().and_then(|d| d.def_id_full(cache))
1534 crate fn primitive_type(&self) -> Option<PrimitiveType> {
1536 Primitive(p) | BorrowedRef { type_: box Primitive(p), .. } => Some(p),
1537 Slice(..) | BorrowedRef { type_: box Slice(..), .. } => Some(PrimitiveType::Slice),
1538 Array(..) | BorrowedRef { type_: box Array(..), .. } => Some(PrimitiveType::Array),
1541 Some(PrimitiveType::Unit)
1543 Some(PrimitiveType::Tuple)
1546 RawPointer(..) => Some(PrimitiveType::RawPointer),
1547 BareFunction(..) => Some(PrimitiveType::Fn),
1548 Never => Some(PrimitiveType::Never),
1553 crate fn is_generic(&self) -> bool {
1555 ResolvedPath { is_generic, .. } => is_generic,
1560 crate fn is_self_type(&self) -> bool {
1562 Generic(name) => name == kw::SelfUpper,
1567 crate fn generics(&self) -> Option<Vec<&Type>> {
1569 ResolvedPath { ref path, .. } => path.segments.last().and_then(|seg| {
1570 if let GenericArgs::AngleBracketed { ref args, .. } = seg.args {
1573 .filter_map(|arg| match arg {
1574 GenericArg::Type(ty) => Some(ty),
1587 crate fn bindings(&self) -> Option<&[TypeBinding]> {
1589 ResolvedPath { ref path, .. } => path.segments.last().and_then(|seg| {
1590 if let GenericArgs::AngleBracketed { ref bindings, .. } = seg.args {
1600 crate fn is_full_generic(&self) -> bool {
1601 matches!(self, Type::Generic(_))
1604 crate fn is_primitive(&self) -> bool {
1605 self.primitive_type().is_some()
1608 crate fn projection(&self) -> Option<(&Type, DefId, Symbol)> {
1609 let (self_, trait_, name) = match self {
1610 QPath { self_type, trait_, name, .. } => (self_type, trait_, name),
1613 let trait_did = match **trait_ {
1614 ResolvedPath { did, .. } => did,
1617 Some((&self_, trait_did, *name))
1622 fn inner_def_id(&self, cache: Option<&Cache>) -> Option<DefId> {
1623 let t: PrimitiveType = match *self {
1624 ResolvedPath { did, .. } => return Some(did),
1625 DynTrait(ref bounds, _) => return bounds[0].trait_.inner_def_id(cache),
1626 Primitive(p) => return cache.and_then(|c| c.primitive_locations.get(&p).cloned()),
1627 BorrowedRef { type_: box Generic(..), .. } => PrimitiveType::Reference,
1628 BorrowedRef { ref type_, .. } => return type_.inner_def_id(cache),
1633 PrimitiveType::Tuple
1636 BareFunction(..) => PrimitiveType::Fn,
1637 Never => PrimitiveType::Never,
1638 Slice(..) => PrimitiveType::Slice,
1639 Array(..) => PrimitiveType::Array,
1640 RawPointer(..) => PrimitiveType::RawPointer,
1641 QPath { ref self_type, .. } => return self_type.inner_def_id(cache),
1642 Generic(_) | Infer | ImplTrait(_) => return None,
1644 cache.and_then(|c| Primitive(t).def_id_full(c))
1648 impl GetDefId for Type {
1649 fn def_id(&self) -> Option<DefId> {
1650 self.inner_def_id(None)
1653 fn def_id_full(&self, cache: &Cache) -> Option<DefId> {
1654 self.inner_def_id(Some(cache))
1658 impl PrimitiveType {
1659 crate fn from_hir(prim: hir::PrimTy) -> PrimitiveType {
1660 use ast::{FloatTy, IntTy, UintTy};
1662 hir::PrimTy::Int(IntTy::Isize) => PrimitiveType::Isize,
1663 hir::PrimTy::Int(IntTy::I8) => PrimitiveType::I8,
1664 hir::PrimTy::Int(IntTy::I16) => PrimitiveType::I16,
1665 hir::PrimTy::Int(IntTy::I32) => PrimitiveType::I32,
1666 hir::PrimTy::Int(IntTy::I64) => PrimitiveType::I64,
1667 hir::PrimTy::Int(IntTy::I128) => PrimitiveType::I128,
1668 hir::PrimTy::Uint(UintTy::Usize) => PrimitiveType::Usize,
1669 hir::PrimTy::Uint(UintTy::U8) => PrimitiveType::U8,
1670 hir::PrimTy::Uint(UintTy::U16) => PrimitiveType::U16,
1671 hir::PrimTy::Uint(UintTy::U32) => PrimitiveType::U32,
1672 hir::PrimTy::Uint(UintTy::U64) => PrimitiveType::U64,
1673 hir::PrimTy::Uint(UintTy::U128) => PrimitiveType::U128,
1674 hir::PrimTy::Float(FloatTy::F32) => PrimitiveType::F32,
1675 hir::PrimTy::Float(FloatTy::F64) => PrimitiveType::F64,
1676 hir::PrimTy::Str => PrimitiveType::Str,
1677 hir::PrimTy::Bool => PrimitiveType::Bool,
1678 hir::PrimTy::Char => PrimitiveType::Char,
1682 crate fn from_symbol(s: Symbol) -> Option<PrimitiveType> {
1684 sym::isize => Some(PrimitiveType::Isize),
1685 sym::i8 => Some(PrimitiveType::I8),
1686 sym::i16 => Some(PrimitiveType::I16),
1687 sym::i32 => Some(PrimitiveType::I32),
1688 sym::i64 => Some(PrimitiveType::I64),
1689 sym::i128 => Some(PrimitiveType::I128),
1690 sym::usize => Some(PrimitiveType::Usize),
1691 sym::u8 => Some(PrimitiveType::U8),
1692 sym::u16 => Some(PrimitiveType::U16),
1693 sym::u32 => Some(PrimitiveType::U32),
1694 sym::u64 => Some(PrimitiveType::U64),
1695 sym::u128 => Some(PrimitiveType::U128),
1696 sym::bool => Some(PrimitiveType::Bool),
1697 sym::char => Some(PrimitiveType::Char),
1698 sym::str => Some(PrimitiveType::Str),
1699 sym::f32 => Some(PrimitiveType::F32),
1700 sym::f64 => Some(PrimitiveType::F64),
1701 sym::array => Some(PrimitiveType::Array),
1702 sym::slice => Some(PrimitiveType::Slice),
1703 sym::tuple => Some(PrimitiveType::Tuple),
1704 sym::unit => Some(PrimitiveType::Unit),
1705 sym::pointer => Some(PrimitiveType::RawPointer),
1706 sym::reference => Some(PrimitiveType::Reference),
1707 kw::Fn => Some(PrimitiveType::Fn),
1708 sym::never => Some(PrimitiveType::Never),
1713 crate fn impls(&self, tcx: TyCtxt<'_>) -> &'static ArrayVec<DefId, 4> {
1714 Self::all_impls(tcx).get(self).expect("missing impl for primitive type")
1717 crate fn all_impls(tcx: TyCtxt<'_>) -> &'static FxHashMap<PrimitiveType, ArrayVec<DefId, 4>> {
1718 static CELL: OnceCell<FxHashMap<PrimitiveType, ArrayVec<DefId, 4>>> = OnceCell::new();
1720 CELL.get_or_init(move || {
1721 use self::PrimitiveType::*;
1723 let single = |a: Option<DefId>| a.into_iter().collect();
1724 let both = |a: Option<DefId>, b: Option<DefId>| -> ArrayVec<_, 4> {
1725 a.into_iter().chain(b).collect()
1728 let lang_items = tcx.lang_items();
1730 Isize => single(lang_items.isize_impl()),
1731 I8 => single(lang_items.i8_impl()),
1732 I16 => single(lang_items.i16_impl()),
1733 I32 => single(lang_items.i32_impl()),
1734 I64 => single(lang_items.i64_impl()),
1735 I128 => single(lang_items.i128_impl()),
1736 Usize => single(lang_items.usize_impl()),
1737 U8 => single(lang_items.u8_impl()),
1738 U16 => single(lang_items.u16_impl()),
1739 U32 => single(lang_items.u32_impl()),
1740 U64 => single(lang_items.u64_impl()),
1741 U128 => single(lang_items.u128_impl()),
1742 F32 => both(lang_items.f32_impl(), lang_items.f32_runtime_impl()),
1743 F64 => both(lang_items.f64_impl(), lang_items.f64_runtime_impl()),
1744 Char => single(lang_items.char_impl()),
1745 Bool => single(lang_items.bool_impl()),
1746 Str => both(lang_items.str_impl(), lang_items.str_alloc_impl()),
1751 .chain(lang_items.slice_u8_impl())
1752 .chain(lang_items.slice_alloc_impl())
1753 .chain(lang_items.slice_u8_alloc_impl())
1756 Array => single(lang_items.array_impl()),
1757 Tuple => ArrayVec::new(),
1758 Unit => ArrayVec::new(),
1763 .chain(lang_items.mut_ptr_impl())
1764 .chain(lang_items.const_slice_ptr_impl())
1765 .chain(lang_items.mut_slice_ptr_impl())
1768 Reference => ArrayVec::new(),
1769 Fn => ArrayVec::new(),
1770 Never => ArrayVec::new(),
1775 crate fn as_sym(&self) -> Symbol {
1776 use PrimitiveType::*;
1778 Isize => sym::isize,
1784 Usize => sym::usize,
1795 Array => sym::array,
1796 Slice => sym::slice,
1797 Tuple => sym::tuple,
1799 RawPointer => sym::pointer,
1800 Reference => sym::reference,
1802 Never => sym::never,
1807 impl From<ast::IntTy> for PrimitiveType {
1808 fn from(int_ty: ast::IntTy) -> PrimitiveType {
1810 ast::IntTy::Isize => PrimitiveType::Isize,
1811 ast::IntTy::I8 => PrimitiveType::I8,
1812 ast::IntTy::I16 => PrimitiveType::I16,
1813 ast::IntTy::I32 => PrimitiveType::I32,
1814 ast::IntTy::I64 => PrimitiveType::I64,
1815 ast::IntTy::I128 => PrimitiveType::I128,
1820 impl From<ast::UintTy> for PrimitiveType {
1821 fn from(uint_ty: ast::UintTy) -> PrimitiveType {
1823 ast::UintTy::Usize => PrimitiveType::Usize,
1824 ast::UintTy::U8 => PrimitiveType::U8,
1825 ast::UintTy::U16 => PrimitiveType::U16,
1826 ast::UintTy::U32 => PrimitiveType::U32,
1827 ast::UintTy::U64 => PrimitiveType::U64,
1828 ast::UintTy::U128 => PrimitiveType::U128,
1833 impl From<ast::FloatTy> for PrimitiveType {
1834 fn from(float_ty: ast::FloatTy) -> PrimitiveType {
1836 ast::FloatTy::F32 => PrimitiveType::F32,
1837 ast::FloatTy::F64 => PrimitiveType::F64,
1842 impl From<ty::IntTy> for PrimitiveType {
1843 fn from(int_ty: ty::IntTy) -> PrimitiveType {
1845 ty::IntTy::Isize => PrimitiveType::Isize,
1846 ty::IntTy::I8 => PrimitiveType::I8,
1847 ty::IntTy::I16 => PrimitiveType::I16,
1848 ty::IntTy::I32 => PrimitiveType::I32,
1849 ty::IntTy::I64 => PrimitiveType::I64,
1850 ty::IntTy::I128 => PrimitiveType::I128,
1855 impl From<ty::UintTy> for PrimitiveType {
1856 fn from(uint_ty: ty::UintTy) -> PrimitiveType {
1858 ty::UintTy::Usize => PrimitiveType::Usize,
1859 ty::UintTy::U8 => PrimitiveType::U8,
1860 ty::UintTy::U16 => PrimitiveType::U16,
1861 ty::UintTy::U32 => PrimitiveType::U32,
1862 ty::UintTy::U64 => PrimitiveType::U64,
1863 ty::UintTy::U128 => PrimitiveType::U128,
1868 impl From<ty::FloatTy> for PrimitiveType {
1869 fn from(float_ty: ty::FloatTy) -> PrimitiveType {
1871 ty::FloatTy::F32 => PrimitiveType::F32,
1872 ty::FloatTy::F64 => PrimitiveType::F64,
1877 impl From<hir::PrimTy> for PrimitiveType {
1878 fn from(prim_ty: hir::PrimTy) -> PrimitiveType {
1880 hir::PrimTy::Int(int_ty) => int_ty.into(),
1881 hir::PrimTy::Uint(uint_ty) => uint_ty.into(),
1882 hir::PrimTy::Float(float_ty) => float_ty.into(),
1883 hir::PrimTy::Str => PrimitiveType::Str,
1884 hir::PrimTy::Bool => PrimitiveType::Bool,
1885 hir::PrimTy::Char => PrimitiveType::Char,
1890 #[derive(Copy, Clone, Debug)]
1891 crate enum Visibility {
1894 /// Visibility inherited from parent.
1896 /// For example, this is the visibility of private items and of enum variants.
1898 /// `pub(crate)`, `pub(super)`, or `pub(in path::to::somewhere)`
1903 crate fn is_public(&self) -> bool {
1904 matches!(self, Visibility::Public)
1908 #[derive(Clone, Debug)]
1909 crate struct Struct {
1910 crate struct_type: CtorKind,
1911 crate generics: Generics,
1912 crate fields: Vec<Item>,
1913 crate fields_stripped: bool,
1916 #[derive(Clone, Debug)]
1917 crate struct Union {
1918 crate generics: Generics,
1919 crate fields: Vec<Item>,
1920 crate fields_stripped: bool,
1923 /// This is a more limited form of the standard Struct, different in that
1924 /// it lacks the things most items have (name, id, parameterization). Found
1925 /// only as a variant in an enum.
1926 #[derive(Clone, Debug)]
1927 crate struct VariantStruct {
1928 crate struct_type: CtorKind,
1929 crate fields: Vec<Item>,
1930 crate fields_stripped: bool,
1933 #[derive(Clone, Debug)]
1935 crate variants: IndexVec<VariantIdx, Item>,
1936 crate generics: Generics,
1937 crate variants_stripped: bool,
1940 #[derive(Clone, Debug)]
1941 crate enum Variant {
1944 Struct(VariantStruct),
1947 /// Small wrapper around [`rustc_span::Span`] that adds helper methods
1948 /// and enforces calling [`rustc_span::Span::source_callsite()`].
1949 #[derive(Copy, Clone, Debug)]
1950 crate struct Span(rustc_span::Span);
1953 /// Wraps a [`rustc_span::Span`]. In case this span is the result of a macro expansion, the
1954 /// span will be updated to point to the macro invocation instead of the macro definition.
1956 /// (See rust-lang/rust#39726)
1957 crate fn new(sp: rustc_span::Span) -> Self {
1958 Self(sp.source_callsite())
1961 crate fn inner(&self) -> rustc_span::Span {
1965 crate fn dummy() -> Self {
1966 Self(rustc_span::DUMMY_SP)
1969 crate fn is_dummy(&self) -> bool {
1973 crate fn filename(&self, sess: &Session) -> FileName {
1974 sess.source_map().span_to_filename(self.0)
1977 crate fn lo(&self, sess: &Session) -> Loc {
1978 sess.source_map().lookup_char_pos(self.0.lo())
1981 crate fn hi(&self, sess: &Session) -> Loc {
1982 sess.source_map().lookup_char_pos(self.0.hi())
1985 crate fn cnum(&self, sess: &Session) -> CrateNum {
1986 // FIXME: is there a time when the lo and hi crate would be different?
1987 self.lo(sess).file.cnum
1991 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
1995 crate segments: Vec<PathSegment>,
1999 crate fn last(&self) -> Symbol {
2000 self.segments.last().expect("segments were empty").name
2003 crate fn last_name(&self) -> SymbolStr {
2004 self.segments.last().expect("segments were empty").name.as_str()
2007 crate fn whole_name(&self) -> String {
2008 String::from(if self.global { "::" } else { "" })
2009 + &self.segments.iter().map(|s| s.name.to_string()).collect::<Vec<_>>().join("::")
2013 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2014 crate enum GenericArg {
2017 Const(Box<Constant>),
2021 // `GenericArg` can occur many times in a single `Path`, so make sure it
2022 // doesn't increase in size unexpectedly.
2023 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2024 rustc_data_structures::static_assert_size!(GenericArg, 80);
2026 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2027 crate enum GenericArgs {
2028 AngleBracketed { args: Vec<GenericArg>, bindings: Vec<TypeBinding> },
2029 Parenthesized { inputs: Vec<Type>, output: Option<Box<Type>> },
2032 // `GenericArgs` is in every `PathSegment`, so its size can significantly
2033 // affect rustdoc's memory usage.
2034 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2035 rustc_data_structures::static_assert_size!(GenericArgs, 56);
2037 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2038 crate struct PathSegment {
2040 crate args: GenericArgs,
2043 // `PathSegment` usually occurs multiple times in every `Path`, so its size can
2044 // significantly affect rustdoc's memory usage.
2045 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2046 rustc_data_structures::static_assert_size!(PathSegment, 64);
2048 #[derive(Clone, Debug)]
2049 crate struct Typedef {
2051 crate generics: Generics,
2052 /// `type_` can come from either the HIR or from metadata. If it comes from HIR, it may be a type
2053 /// alias instead of the final type. This will always have the final type, regardless of whether
2054 /// `type_` came from HIR or from metadata.
2056 /// If `item_type.is_none()`, `type_` is guarenteed to come from metadata (and therefore hold the
2058 crate item_type: Option<Type>,
2061 impl GetDefId for Typedef {
2062 fn def_id(&self) -> Option<DefId> {
2066 fn def_id_full(&self, cache: &Cache) -> Option<DefId> {
2067 self.type_.def_id_full(cache)
2071 #[derive(Clone, Debug)]
2072 crate struct OpaqueTy {
2073 crate bounds: Vec<GenericBound>,
2074 crate generics: Generics,
2077 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2078 crate struct BareFunctionDecl {
2079 crate unsafety: hir::Unsafety,
2080 crate generic_params: Vec<GenericParamDef>,
2085 #[derive(Clone, Debug)]
2086 crate struct Static {
2088 crate mutability: Mutability,
2089 crate expr: Option<BodyId>,
2092 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2093 crate struct Constant {
2095 crate kind: ConstantKind,
2098 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
2099 crate enum ConstantKind {
2100 /// This is the wrapper around `ty::Const` for a non-local constant. Because it doesn't have a
2101 /// `BodyId`, we need to handle it on its own.
2103 /// Note that `ty::Const` includes generic parameters, and may not always be uniquely identified
2104 /// by a DefId. So this field must be different from `Extern`.
2105 TyConst { expr: String },
2106 /// A constant (expression) that's not an item or associated item. These are usually found
2107 /// nested inside types (e.g., array lengths) or expressions (e.g., repeat counts), and also
2108 /// used to define explicit discriminant values for enum variants.
2109 Anonymous { body: BodyId },
2110 /// A constant from a different crate.
2111 Extern { def_id: DefId },
2112 /// `const FOO: u32 = ...;`
2113 Local { def_id: DefId, body: BodyId },
2117 crate fn expr(&self, tcx: TyCtxt<'_>) -> String {
2119 ConstantKind::TyConst { ref expr } => expr.clone(),
2120 ConstantKind::Extern { def_id } => print_inlined_const(tcx, def_id),
2121 ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2122 print_const_expr(tcx, body)
2127 crate fn value(&self, tcx: TyCtxt<'_>) -> Option<String> {
2129 ConstantKind::TyConst { .. } | ConstantKind::Anonymous { .. } => None,
2130 ConstantKind::Extern { def_id } | ConstantKind::Local { def_id, .. } => {
2131 print_evaluated_const(tcx, def_id)
2136 crate fn is_literal(&self, tcx: TyCtxt<'_>) -> bool {
2138 ConstantKind::TyConst { .. } => false,
2139 ConstantKind::Extern { def_id } => def_id.as_local().map_or(false, |def_id| {
2140 is_literal_expr(tcx, tcx.hir().local_def_id_to_hir_id(def_id))
2142 ConstantKind::Local { body, .. } | ConstantKind::Anonymous { body } => {
2143 is_literal_expr(tcx, body.hir_id)
2149 #[derive(Clone, Debug)]
2152 crate unsafety: hir::Unsafety,
2153 crate generics: Generics,
2154 crate trait_: Option<Type>,
2156 crate items: Vec<Item>,
2157 crate negative_polarity: bool,
2158 crate synthetic: bool,
2159 crate blanket_impl: Option<Box<Type>>,
2163 crate fn provided_trait_methods(&self, tcx: TyCtxt<'_>) -> FxHashSet<Symbol> {
2166 .map(|did| tcx.provided_trait_methods(did).map(|meth| meth.ident.name).collect())
2167 .unwrap_or_default()
2171 #[derive(Clone, Debug)]
2172 crate struct Import {
2173 crate kind: ImportKind,
2174 crate source: ImportSource,
2175 crate should_be_displayed: bool,
2179 crate fn new_simple(name: Symbol, source: ImportSource, should_be_displayed: bool) -> Self {
2180 Self { kind: ImportKind::Simple(name), source, should_be_displayed }
2183 crate fn new_glob(source: ImportSource, should_be_displayed: bool) -> Self {
2184 Self { kind: ImportKind::Glob, source, should_be_displayed }
2188 #[derive(Clone, Debug)]
2189 crate enum ImportKind {
2190 // use source as str;
2196 #[derive(Clone, Debug)]
2197 crate struct ImportSource {
2199 crate did: Option<DefId>,
2202 #[derive(Clone, Debug)]
2203 crate struct Macro {
2204 crate source: String,
2205 crate imported_from: Option<Symbol>,
2208 #[derive(Clone, Debug)]
2209 crate struct ProcMacro {
2210 crate kind: MacroKind,
2211 crate helpers: Vec<Symbol>,
2214 /// An type binding on an associated type (e.g., `A = Bar` in `Foo<A = Bar>` or
2215 /// `A: Send + Sync` in `Foo<A: Send + Sync>`).
2216 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2217 crate struct TypeBinding {
2219 crate kind: TypeBindingKind,
2222 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
2223 crate enum TypeBindingKind {
2224 Equality { ty: Type },
2225 Constraint { bounds: Vec<GenericBound> },
2229 crate fn ty(&self) -> &Type {
2231 TypeBindingKind::Equality { ref ty } => ty,
2232 _ => panic!("expected equality type binding for parenthesized generic args"),