1 //! This module contains the "cleaned" pieces of the AST, and the functions
8 mod render_macro_matchers;
14 use rustc_attr as attr;
15 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
17 use rustc_hir::def::{CtorKind, DefKind, Res};
18 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
19 use rustc_hir::PredicateOrigin;
20 use rustc_infer::infer::region_constraints::{Constraint, RegionConstraintData};
21 use rustc_middle::middle::resolve_lifetime as rl;
22 use rustc_middle::ty::fold::TypeFolder;
23 use rustc_middle::ty::subst::{InternalSubsts, Subst};
24 use rustc_middle::ty::{self, AdtKind, DefIdTree, EarlyBinder, Lift, Ty, TyCtxt};
25 use rustc_middle::{bug, span_bug};
26 use rustc_span::hygiene::{AstPass, MacroKind};
27 use rustc_span::symbol::{kw, sym, Ident, Symbol};
28 use rustc_span::{self, ExpnKind};
29 use rustc_typeck::hir_ty_to_ty;
31 use std::assert_matches::assert_matches;
32 use std::collections::hash_map::Entry;
33 use std::collections::BTreeMap;
34 use std::default::Default;
38 use crate::core::{self, DocContext, ImplTraitParam};
39 use crate::formats::item_type::ItemType;
40 use crate::visit_ast::Module as DocModule;
44 pub(crate) use self::types::*;
45 pub(crate) use self::utils::{get_auto_trait_and_blanket_impls, krate, register_res};
47 pub(crate) trait Clean<'tcx, T> {
48 fn clean(&self, cx: &mut DocContext<'tcx>) -> T;
51 pub(crate) fn clean_doc_module<'tcx>(doc: &DocModule<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
52 let mut items: Vec<Item> = vec![];
53 let mut inserted = FxHashSet::default();
54 items.extend(doc.foreigns.iter().map(|(item, renamed)| {
55 let item = clean_maybe_renamed_foreign_item(cx, item, *renamed);
56 if let Some(name) = item.name {
57 inserted.insert((item.type_(), name));
61 items.extend(doc.mods.iter().map(|x| {
62 inserted.insert((ItemType::Module, x.name));
63 clean_doc_module(x, cx)
66 // Split up imports from all other items.
68 // This covers the case where somebody does an import which should pull in an item,
69 // but there's already an item with the same namespace and same name. Rust gives
70 // priority to the not-imported one, so we should, too.
71 items.extend(doc.items.iter().flat_map(|(item, renamed)| {
72 // First, lower everything other than imports.
73 if matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
76 let v = clean_maybe_renamed_item(cx, item, *renamed);
78 if let Some(name) = item.name {
79 inserted.insert((item.type_(), name));
84 items.extend(doc.items.iter().flat_map(|(item, renamed)| {
85 // Now we actually lower the imports, skipping everything else.
86 if let hir::ItemKind::Use(path, hir::UseKind::Glob) = item.kind {
87 let name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
88 clean_use_statement(item, name, path, hir::UseKind::Glob, cx, &mut inserted)
90 // skip everything else
95 // determine if we should display the inner contents or
96 // the outer `mod` item for the source code.
98 let span = Span::new({
99 let where_outer = doc.where_outer(cx.tcx);
100 let sm = cx.sess().source_map();
101 let outer = sm.lookup_char_pos(where_outer.lo());
102 let inner = sm.lookup_char_pos(doc.where_inner.lo());
103 if outer.file.start_pos == inner.file.start_pos {
107 // mod foo; (and a separate SourceFile for the contents)
112 Item::from_hir_id_and_parts(doc.id, Some(doc.name), ModuleItem(Module { items, span }), cx)
115 fn clean_generic_bound<'tcx>(
116 bound: &hir::GenericBound<'tcx>,
117 cx: &mut DocContext<'tcx>,
118 ) -> Option<GenericBound> {
120 hir::GenericBound::Outlives(lt) => GenericBound::Outlives(clean_lifetime(lt, cx)),
121 hir::GenericBound::LangItemTrait(lang_item, span, _, generic_args) => {
122 let def_id = cx.tcx.require_lang_item(lang_item, Some(span));
124 let trait_ref = ty::TraitRef::identity(cx.tcx, def_id).skip_binder();
126 let generic_args = clean_generic_args(generic_args, cx);
127 let GenericArgs::AngleBracketed { bindings, .. } = generic_args
129 bug!("clean: parenthesized `GenericBound::LangItemTrait`");
132 let trait_ = clean_trait_ref_with_bindings(cx, trait_ref, &bindings);
133 GenericBound::TraitBound(
134 PolyTrait { trait_, generic_params: vec![] },
135 hir::TraitBoundModifier::None,
138 hir::GenericBound::Trait(ref t, modifier) => {
139 // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
140 if modifier == hir::TraitBoundModifier::MaybeConst
141 && cx.tcx.lang_items().destruct_trait() == Some(t.trait_ref.trait_def_id().unwrap())
146 GenericBound::TraitBound(clean_poly_trait_ref(t, cx), modifier)
151 pub(crate) fn clean_trait_ref_with_bindings<'tcx>(
152 cx: &mut DocContext<'tcx>,
153 trait_ref: ty::TraitRef<'tcx>,
154 bindings: &[TypeBinding],
156 let kind = cx.tcx.def_kind(trait_ref.def_id).into();
157 if !matches!(kind, ItemType::Trait | ItemType::TraitAlias) {
158 span_bug!(cx.tcx.def_span(trait_ref.def_id), "`TraitRef` had unexpected kind {:?}", kind);
160 inline::record_extern_fqn(cx, trait_ref.def_id, kind);
161 let path = external_path(cx, trait_ref.def_id, true, bindings.to_vec(), trait_ref.substs);
163 debug!("ty::TraitRef\n subst: {:?}\n", trait_ref.substs);
168 fn clean_poly_trait_ref_with_bindings<'tcx>(
169 cx: &mut DocContext<'tcx>,
170 poly_trait_ref: ty::PolyTraitRef<'tcx>,
171 bindings: &[TypeBinding],
173 let poly_trait_ref = poly_trait_ref.lift_to_tcx(cx.tcx).unwrap();
175 // collect any late bound regions
176 let late_bound_regions: Vec<_> = cx
178 .collect_referenced_late_bound_regions(&poly_trait_ref)
180 .filter_map(|br| match br {
181 ty::BrNamed(_, name) if name != kw::UnderscoreLifetime => Some(GenericParamDef {
183 kind: GenericParamDefKind::Lifetime { outlives: vec![] },
189 let trait_ = clean_trait_ref_with_bindings(cx, poly_trait_ref.skip_binder(), bindings);
190 GenericBound::TraitBound(
191 PolyTrait { trait_, generic_params: late_bound_regions },
192 hir::TraitBoundModifier::None,
196 fn clean_lifetime<'tcx>(lifetime: hir::Lifetime, cx: &mut DocContext<'tcx>) -> Lifetime {
197 let def = cx.tcx.named_region(lifetime.hir_id);
199 rl::Region::EarlyBound(_, node_id)
200 | rl::Region::LateBound(_, _, node_id)
201 | rl::Region::Free(_, node_id),
204 if let Some(lt) = cx.substs.get(&node_id).and_then(|p| p.as_lt()).cloned() {
208 Lifetime(lifetime.name.ident().name)
211 pub(crate) fn clean_const<'tcx>(constant: &hir::ConstArg, cx: &mut DocContext<'tcx>) -> Constant {
212 let def_id = cx.tcx.hir().body_owner_def_id(constant.value.body).to_def_id();
214 type_: clean_middle_ty(cx.tcx.type_of(def_id), cx, Some(def_id)),
215 kind: ConstantKind::Anonymous { body: constant.value.body },
219 pub(crate) fn clean_middle_const<'tcx>(
220 constant: ty::Const<'tcx>,
221 cx: &mut DocContext<'tcx>,
223 // FIXME: instead of storing the stringified expression, store `self` directly instead.
225 type_: clean_middle_ty(constant.ty(), cx, None),
226 kind: ConstantKind::TyConst { expr: constant.to_string() },
230 pub(crate) fn clean_middle_region<'tcx>(region: ty::Region<'tcx>) -> Option<Lifetime> {
232 ty::ReStatic => Some(Lifetime::statik()),
233 ty::ReLateBound(_, ty::BoundRegion { kind: ty::BrNamed(_, name), .. }) => {
234 if name != kw::UnderscoreLifetime { Some(Lifetime(name)) } else { None }
236 ty::ReEarlyBound(ref data) => {
237 if data.name != kw::UnderscoreLifetime {
238 Some(Lifetime(data.name))
246 | ty::RePlaceholder(..)
249 debug!("cannot clean region {:?}", region);
255 fn clean_where_predicate<'tcx>(
256 predicate: &hir::WherePredicate<'tcx>,
257 cx: &mut DocContext<'tcx>,
258 ) -> Option<WherePredicate> {
259 if !predicate.in_where_clause() {
262 Some(match *predicate {
263 hir::WherePredicate::BoundPredicate(ref wbp) => {
264 let bound_params = wbp
265 .bound_generic_params
268 // Higher-ranked params must be lifetimes.
269 // Higher-ranked lifetimes can't have bounds.
272 hir::GenericParam { kind: hir::GenericParamKind::Lifetime { .. }, .. }
274 Lifetime(param.name.ident().name)
277 WherePredicate::BoundPredicate {
278 ty: clean_ty(wbp.bounded_ty, cx),
279 bounds: wbp.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
284 hir::WherePredicate::RegionPredicate(ref wrp) => WherePredicate::RegionPredicate {
285 lifetime: clean_lifetime(wrp.lifetime, cx),
286 bounds: wrp.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
289 hir::WherePredicate::EqPredicate(ref wrp) => WherePredicate::EqPredicate {
290 lhs: clean_ty(wrp.lhs_ty, cx),
291 rhs: clean_ty(wrp.rhs_ty, cx).into(),
296 pub(crate) fn clean_predicate<'tcx>(
297 predicate: ty::Predicate<'tcx>,
298 cx: &mut DocContext<'tcx>,
299 ) -> Option<WherePredicate> {
300 let bound_predicate = predicate.kind();
301 match bound_predicate.skip_binder() {
302 ty::PredicateKind::Trait(pred) => {
303 clean_poly_trait_predicate(bound_predicate.rebind(pred), cx)
305 ty::PredicateKind::RegionOutlives(pred) => clean_region_outlives_predicate(pred),
306 ty::PredicateKind::TypeOutlives(pred) => clean_type_outlives_predicate(pred, cx),
307 ty::PredicateKind::Projection(pred) => Some(clean_projection_predicate(pred, cx)),
308 ty::PredicateKind::ConstEvaluatable(..) => None,
309 ty::PredicateKind::WellFormed(..) => None,
311 ty::PredicateKind::Subtype(..)
312 | ty::PredicateKind::Coerce(..)
313 | ty::PredicateKind::ObjectSafe(..)
314 | ty::PredicateKind::ClosureKind(..)
315 | ty::PredicateKind::ConstEquate(..)
316 | ty::PredicateKind::TypeWellFormedFromEnv(..) => panic!("not user writable"),
320 fn clean_poly_trait_predicate<'tcx>(
321 pred: ty::PolyTraitPredicate<'tcx>,
322 cx: &mut DocContext<'tcx>,
323 ) -> Option<WherePredicate> {
324 // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
325 if pred.skip_binder().constness == ty::BoundConstness::ConstIfConst
326 && Some(pred.skip_binder().def_id()) == cx.tcx.lang_items().destruct_trait()
331 let poly_trait_ref = pred.map_bound(|pred| pred.trait_ref);
332 Some(WherePredicate::BoundPredicate {
333 ty: clean_middle_ty(poly_trait_ref.skip_binder().self_ty(), cx, None),
334 bounds: vec![clean_poly_trait_ref_with_bindings(cx, poly_trait_ref, &[])],
335 bound_params: Vec::new(),
339 fn clean_region_outlives_predicate<'tcx>(
340 pred: ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>,
341 ) -> Option<WherePredicate> {
342 let ty::OutlivesPredicate(a, b) = pred;
344 if a.is_empty() && b.is_empty() {
348 Some(WherePredicate::RegionPredicate {
349 lifetime: clean_middle_region(a).expect("failed to clean lifetime"),
350 bounds: vec![GenericBound::Outlives(
351 clean_middle_region(b).expect("failed to clean bounds"),
356 fn clean_type_outlives_predicate<'tcx>(
357 pred: ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>,
358 cx: &mut DocContext<'tcx>,
359 ) -> Option<WherePredicate> {
360 let ty::OutlivesPredicate(ty, lt) = pred;
366 Some(WherePredicate::BoundPredicate {
367 ty: clean_middle_ty(ty, cx, None),
368 bounds: vec![GenericBound::Outlives(
369 clean_middle_region(lt).expect("failed to clean lifetimes"),
371 bound_params: Vec::new(),
375 fn clean_middle_term<'tcx>(term: ty::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
377 ty::Term::Ty(ty) => Term::Type(clean_middle_ty(ty, cx, None)),
378 ty::Term::Const(c) => Term::Constant(clean_middle_const(c, cx)),
382 fn clean_hir_term<'tcx>(term: &hir::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
384 hir::Term::Ty(ty) => Term::Type(clean_ty(ty, cx)),
385 hir::Term::Const(c) => {
386 let def_id = cx.tcx.hir().local_def_id(c.hir_id);
387 Term::Constant(clean_middle_const(ty::Const::from_anon_const(cx.tcx, def_id), cx))
392 fn clean_projection_predicate<'tcx>(
393 pred: ty::ProjectionPredicate<'tcx>,
394 cx: &mut DocContext<'tcx>,
395 ) -> WherePredicate {
396 let ty::ProjectionPredicate { projection_ty, term } = pred;
397 WherePredicate::EqPredicate {
398 lhs: clean_projection(projection_ty, cx, None),
399 rhs: clean_middle_term(term, cx),
403 fn clean_projection<'tcx>(
404 ty: ty::ProjectionTy<'tcx>,
405 cx: &mut DocContext<'tcx>,
406 def_id: Option<DefId>,
408 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
409 let trait_ = clean_trait_ref_with_bindings(cx, lifted.trait_ref(cx.tcx), &[]);
410 let self_type = clean_middle_ty(ty.self_ty(), cx, None);
411 let self_def_id = if let Some(def_id) = def_id {
412 cx.tcx.opt_parent(def_id).or(Some(def_id))
414 self_type.def_id(&cx.cache)
416 let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
418 assoc: Box::new(projection_to_path_segment(ty, cx)),
420 self_type: Box::new(self_type),
425 fn compute_should_show_cast(self_def_id: Option<DefId>, trait_: &Path, self_type: &Type) -> bool {
426 !trait_.segments.is_empty()
428 .zip(Some(trait_.def_id()))
429 .map_or(!self_type.is_self_type(), |(id, trait_)| id != trait_)
432 fn projection_to_path_segment<'tcx>(
433 ty: ty::ProjectionTy<'tcx>,
434 cx: &mut DocContext<'tcx>,
436 let item = cx.tcx.associated_item(ty.item_def_id);
437 let generics = cx.tcx.generics_of(ty.item_def_id);
440 args: GenericArgs::AngleBracketed {
441 args: substs_to_args(cx, &ty.substs[generics.parent_count..], false).into(),
442 bindings: Default::default(),
447 fn clean_generic_param_def<'tcx>(
448 def: &ty::GenericParamDef,
449 cx: &mut DocContext<'tcx>,
450 ) -> GenericParamDef {
451 let (name, kind) = match def.kind {
452 ty::GenericParamDefKind::Lifetime => {
453 (def.name, GenericParamDefKind::Lifetime { outlives: vec![] })
455 ty::GenericParamDefKind::Type { has_default, synthetic, .. } => {
456 let default = if has_default {
457 Some(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id)))
463 GenericParamDefKind::Type {
465 bounds: vec![], // These are filled in from the where-clauses.
466 default: default.map(Box::new),
471 ty::GenericParamDefKind::Const { has_default } => (
473 GenericParamDefKind::Const {
475 ty: Box::new(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id))),
476 default: match has_default {
477 true => Some(Box::new(cx.tcx.const_param_default(def.def_id).to_string())),
484 GenericParamDef { name, kind }
487 fn clean_generic_param<'tcx>(
488 cx: &mut DocContext<'tcx>,
489 generics: Option<&hir::Generics<'tcx>>,
490 param: &hir::GenericParam<'tcx>,
491 ) -> GenericParamDef {
492 let did = cx.tcx.hir().local_def_id(param.hir_id);
493 let (name, kind) = match param.kind {
494 hir::GenericParamKind::Lifetime { .. } => {
495 let outlives = if let Some(generics) = generics {
497 .outlives_for_param(did)
498 .filter(|bp| !bp.in_where_clause)
499 .flat_map(|bp| bp.bounds)
500 .map(|bound| match bound {
501 hir::GenericBound::Outlives(lt) => clean_lifetime(*lt, cx),
508 (param.name.ident().name, GenericParamDefKind::Lifetime { outlives })
510 hir::GenericParamKind::Type { ref default, synthetic } => {
511 let bounds = if let Some(generics) = generics {
513 .bounds_for_param(did)
514 .filter(|bp| bp.origin != PredicateOrigin::WhereClause)
515 .flat_map(|bp| bp.bounds)
516 .filter_map(|x| clean_generic_bound(x, cx))
522 param.name.ident().name,
523 GenericParamDefKind::Type {
524 did: did.to_def_id(),
526 default: default.map(|t| clean_ty(t, cx)).map(Box::new),
531 hir::GenericParamKind::Const { ty, default } => (
532 param.name.ident().name,
533 GenericParamDefKind::Const {
534 did: did.to_def_id(),
535 ty: Box::new(clean_ty(ty, cx)),
536 default: default.map(|ct| {
537 let def_id = cx.tcx.hir().local_def_id(ct.hir_id);
538 Box::new(ty::Const::from_anon_const(cx.tcx, def_id).to_string())
544 GenericParamDef { name, kind }
547 /// Synthetic type-parameters are inserted after normal ones.
548 /// In order for normal parameters to be able to refer to synthetic ones,
549 /// scans them first.
550 fn is_impl_trait(param: &hir::GenericParam<'_>) -> bool {
552 hir::GenericParamKind::Type { synthetic, .. } => synthetic,
557 /// This can happen for `async fn`, e.g. `async fn f<'_>(&'_ self)`.
559 /// See `lifetime_to_generic_param` in `rustc_ast_lowering` for more information.
560 fn is_elided_lifetime(param: &hir::GenericParam<'_>) -> bool {
561 matches!(param.kind, hir::GenericParamKind::Lifetime { kind: hir::LifetimeParamKind::Elided })
564 pub(crate) fn clean_generics<'tcx>(
565 gens: &hir::Generics<'tcx>,
566 cx: &mut DocContext<'tcx>,
568 let impl_trait_params = gens
571 .filter(|param| is_impl_trait(param))
573 let param = clean_generic_param(cx, Some(gens), param);
575 GenericParamDefKind::Lifetime { .. } => unreachable!(),
576 GenericParamDefKind::Type { did, ref bounds, .. } => {
577 cx.impl_trait_bounds.insert(did.into(), bounds.clone());
579 GenericParamDefKind::Const { .. } => unreachable!(),
583 .collect::<Vec<_>>();
585 let mut params = Vec::with_capacity(gens.params.len());
586 for p in gens.params.iter().filter(|p| !is_impl_trait(p) && !is_elided_lifetime(p)) {
587 let p = clean_generic_param(cx, Some(gens), p);
590 params.extend(impl_trait_params);
592 let mut generics = Generics {
594 where_predicates: gens
597 .filter_map(|x| clean_where_predicate(x, cx))
601 // Some duplicates are generated for ?Sized bounds between type params and where
602 // predicates. The point in here is to move the bounds definitions from type params
603 // to where predicates when such cases occur.
604 for where_pred in &mut generics.where_predicates {
606 WherePredicate::BoundPredicate { ty: Generic(ref name), ref mut bounds, .. } => {
607 if bounds.is_empty() {
608 for param in &mut generics.params {
610 GenericParamDefKind::Lifetime { .. } => {}
611 GenericParamDefKind::Type { bounds: ref mut ty_bounds, .. } => {
612 if ¶m.name == name {
613 mem::swap(bounds, ty_bounds);
617 GenericParamDefKind::Const { .. } => {}
628 fn clean_ty_generics<'tcx>(
629 cx: &mut DocContext<'tcx>,
631 preds: ty::GenericPredicates<'tcx>,
633 // Don't populate `cx.impl_trait_bounds` before `clean`ning `where` clauses,
634 // since `Clean for ty::Predicate` would consume them.
635 let mut impl_trait = BTreeMap::<ImplTraitParam, Vec<GenericBound>>::default();
637 // Bounds in the type_params and lifetimes fields are repeated in the
638 // predicates field (see rustc_typeck::collect::ty_generics), so remove
640 let stripped_params = gens
643 .filter_map(|param| match param.kind {
644 ty::GenericParamDefKind::Lifetime if param.name == kw::UnderscoreLifetime => None,
645 ty::GenericParamDefKind::Lifetime => Some(clean_generic_param_def(param, cx)),
646 ty::GenericParamDefKind::Type { synthetic, .. } => {
647 if param.name == kw::SelfUpper {
648 assert_eq!(param.index, 0);
652 impl_trait.insert(param.index.into(), vec![]);
655 Some(clean_generic_param_def(param, cx))
657 ty::GenericParamDefKind::Const { .. } => Some(clean_generic_param_def(param, cx)),
659 .collect::<Vec<GenericParamDef>>();
661 // param index -> [(DefId of trait, associated type name and generics, type)]
662 let mut impl_trait_proj = FxHashMap::<u32, Vec<(DefId, PathSegment, Ty<'_>)>>::default();
664 let where_predicates = preds
668 let mut projection = None;
669 let param_idx = (|| {
670 let bound_p = p.kind();
671 match bound_p.skip_binder() {
672 ty::PredicateKind::Trait(pred) => {
673 if let ty::Param(param) = pred.self_ty().kind() {
674 return Some(param.index);
677 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ty, _reg)) => {
678 if let ty::Param(param) = ty.kind() {
679 return Some(param.index);
682 ty::PredicateKind::Projection(p) => {
683 if let ty::Param(param) = p.projection_ty.self_ty().kind() {
684 projection = Some(bound_p.rebind(p));
685 return Some(param.index);
694 if let Some(param_idx) = param_idx {
695 if let Some(b) = impl_trait.get_mut(¶m_idx.into()) {
696 let p: WherePredicate = clean_predicate(*p, cx)?;
703 .filter(|b| !b.is_sized_bound(cx)),
706 let proj = projection.map(|p| {
708 clean_projection(p.skip_binder().projection_ty, cx, None),
709 p.skip_binder().term,
712 if let Some(((_, trait_did, name), rhs)) = proj
714 .and_then(|(lhs, rhs): &(Type, _)| Some((lhs.projection()?, rhs)))
716 // FIXME(...): Remove this unwrap()
717 impl_trait_proj.entry(param_idx).or_default().push((
730 .collect::<Vec<_>>();
732 for (param, mut bounds) in impl_trait {
733 // Move trait bounds to the front.
734 bounds.sort_by_key(|b| !matches!(b, GenericBound::TraitBound(..)));
736 if let crate::core::ImplTraitParam::ParamIndex(idx) = param {
737 if let Some(proj) = impl_trait_proj.remove(&idx) {
738 for (trait_did, name, rhs) in proj {
739 let rhs = clean_middle_ty(rhs, cx, None);
740 simplify::merge_bounds(cx, &mut bounds, trait_did, name, &Term::Type(rhs));
747 cx.impl_trait_bounds.insert(param, bounds);
750 // Now that `cx.impl_trait_bounds` is populated, we can process
751 // remaining predicates which could contain `impl Trait`.
752 let mut where_predicates =
753 where_predicates.into_iter().flat_map(|p| clean_predicate(*p, cx)).collect::<Vec<_>>();
755 // Type parameters have a Sized bound by default unless removed with
756 // ?Sized. Scan through the predicates and mark any type parameter with
757 // a Sized bound, removing the bounds as we find them.
759 // Note that associated types also have a sized bound by default, but we
760 // don't actually know the set of associated types right here so that's
761 // handled in cleaning associated types
762 let mut sized_params = FxHashSet::default();
763 where_predicates.retain(|pred| match *pred {
764 WherePredicate::BoundPredicate { ty: Generic(ref g), ref bounds, .. } => {
765 if bounds.iter().any(|b| b.is_sized_bound(cx)) {
766 sized_params.insert(*g);
775 // Run through the type parameters again and insert a ?Sized
776 // unbound for any we didn't find to be Sized.
777 for tp in &stripped_params {
778 if matches!(tp.kind, types::GenericParamDefKind::Type { .. })
779 && !sized_params.contains(&tp.name)
781 where_predicates.push(WherePredicate::BoundPredicate {
782 ty: Type::Generic(tp.name),
783 bounds: vec![GenericBound::maybe_sized(cx)],
784 bound_params: Vec::new(),
789 // It would be nice to collect all of the bounds on a type and recombine
790 // them if possible, to avoid e.g., `where T: Foo, T: Bar, T: Sized, T: 'a`
791 // and instead see `where T: Foo + Bar + Sized + 'a`
794 params: stripped_params,
795 where_predicates: simplify::where_clauses(cx, where_predicates),
799 fn clean_fn_or_proc_macro<'tcx>(
800 item: &hir::Item<'tcx>,
801 sig: &hir::FnSig<'tcx>,
802 generics: &hir::Generics<'tcx>,
803 body_id: hir::BodyId,
805 cx: &mut DocContext<'tcx>,
807 let attrs = cx.tcx.hir().attrs(item.hir_id());
808 let macro_kind = attrs.iter().find_map(|a| {
809 if a.has_name(sym::proc_macro) {
810 Some(MacroKind::Bang)
811 } else if a.has_name(sym::proc_macro_derive) {
812 Some(MacroKind::Derive)
813 } else if a.has_name(sym::proc_macro_attribute) {
814 Some(MacroKind::Attr)
821 if kind == MacroKind::Derive {
823 .lists(sym::proc_macro_derive)
824 .find_map(|mi| mi.ident())
825 .expect("proc-macro derives require a name")
829 let mut helpers = Vec::new();
830 for mi in attrs.lists(sym::proc_macro_derive) {
831 if !mi.has_name(sym::attributes) {
835 if let Some(list) = mi.meta_item_list() {
836 for inner_mi in list {
837 if let Some(ident) = inner_mi.ident() {
838 helpers.push(ident.name);
843 ProcMacroItem(ProcMacro { kind, helpers })
846 let mut func = clean_function(cx, sig, generics, body_id);
847 clean_fn_decl_legacy_const_generics(&mut func, attrs);
853 /// This is needed to make it more "readable" when documenting functions using
854 /// `rustc_legacy_const_generics`. More information in
855 /// <https://github.com/rust-lang/rust/issues/83167>.
856 fn clean_fn_decl_legacy_const_generics(func: &mut Function, attrs: &[ast::Attribute]) {
857 for meta_item_list in attrs
859 .filter(|a| a.has_name(sym::rustc_legacy_const_generics))
860 .filter_map(|a| a.meta_item_list())
862 for (pos, literal) in meta_item_list.iter().filter_map(|meta| meta.literal()).enumerate() {
864 ast::LitKind::Int(a, _) => {
865 let gen = func.generics.params.remove(0);
866 if let GenericParamDef { name, kind: GenericParamDefKind::Const { ty, .. } } =
872 .insert(a as _, Argument { name, type_: *ty, is_const: true });
874 panic!("unexpected non const in position {pos}");
877 _ => panic!("invalid arg index"),
883 fn clean_function<'tcx>(
884 cx: &mut DocContext<'tcx>,
885 sig: &hir::FnSig<'tcx>,
886 generics: &hir::Generics<'tcx>,
887 body_id: hir::BodyId,
889 let (generics, decl) = enter_impl_trait(cx, |cx| {
890 // NOTE: generics must be cleaned before args
891 let generics = clean_generics(generics, cx);
892 let args = clean_args_from_types_and_body_id(cx, sig.decl.inputs, body_id);
893 let decl = clean_fn_decl_with_args(cx, sig.decl, args);
896 Box::new(Function { decl, generics })
899 fn clean_args_from_types_and_names<'tcx>(
900 cx: &mut DocContext<'tcx>,
901 types: &[hir::Ty<'tcx>],
909 let mut name = names.get(i).map_or(kw::Empty, |ident| ident.name);
911 name = kw::Underscore;
913 Argument { name, type_: clean_ty(ty, cx), is_const: false }
919 fn clean_args_from_types_and_body_id<'tcx>(
920 cx: &mut DocContext<'tcx>,
921 types: &[hir::Ty<'tcx>],
922 body_id: hir::BodyId,
924 let body = cx.tcx.hir().body(body_id);
930 .map(|(i, ty)| Argument {
931 name: name_from_pat(body.params[i].pat),
932 type_: clean_ty(ty, cx),
939 fn clean_fn_decl_with_args<'tcx>(
940 cx: &mut DocContext<'tcx>,
941 decl: &hir::FnDecl<'tcx>,
944 let output = match decl.output {
945 hir::FnRetTy::Return(typ) => Return(clean_ty(typ, cx)),
946 hir::FnRetTy::DefaultReturn(..) => DefaultReturn,
948 FnDecl { inputs: args, output, c_variadic: decl.c_variadic }
951 fn clean_fn_decl_from_did_and_sig<'tcx>(
952 cx: &mut DocContext<'tcx>,
954 sig: ty::PolyFnSig<'tcx>,
956 let mut names = did.map_or(&[] as &[_], |did| cx.tcx.fn_arg_names(did)).iter();
958 // We assume all empty tuples are default return type. This theoretically can discard `-> ()`,
959 // but shouldn't change any code meaning.
960 let output = match clean_middle_ty(sig.skip_binder().output(), cx, None) {
961 Type::Tuple(inner) if inner.is_empty() => DefaultReturn,
967 c_variadic: sig.skip_binder().c_variadic,
974 type_: clean_middle_ty(*t, cx, None),
975 name: names.next().map_or(kw::Empty, |i| i.name),
983 fn clean_trait_ref<'tcx>(trait_ref: &hir::TraitRef<'tcx>, cx: &mut DocContext<'tcx>) -> Path {
984 let path = clean_path(trait_ref.path, cx);
985 register_res(cx, path.res);
989 fn clean_poly_trait_ref<'tcx>(
990 poly_trait_ref: &hir::PolyTraitRef<'tcx>,
991 cx: &mut DocContext<'tcx>,
994 trait_: clean_trait_ref(&poly_trait_ref.trait_ref, cx),
995 generic_params: poly_trait_ref
996 .bound_generic_params
998 .filter(|p| !is_elided_lifetime(p))
999 .map(|x| clean_generic_param(cx, None, x))
1004 fn clean_trait_item<'tcx>(trait_item: &hir::TraitItem<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1005 let local_did = trait_item.def_id.to_def_id();
1006 cx.with_param_env(local_did, |cx| {
1007 let inner = match trait_item.kind {
1008 hir::TraitItemKind::Const(ty, Some(default)) => AssocConstItem(
1010 ConstantKind::Local { def_id: local_did, body: default },
1012 hir::TraitItemKind::Const(ty, None) => TyAssocConstItem(clean_ty(ty, cx)),
1013 hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
1014 let m = clean_function(cx, sig, trait_item.generics, body);
1017 hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Required(names)) => {
1018 let (generics, decl) = enter_impl_trait(cx, |cx| {
1019 // NOTE: generics must be cleaned before args
1020 let generics = clean_generics(trait_item.generics, cx);
1021 let args = clean_args_from_types_and_names(cx, sig.decl.inputs, names);
1022 let decl = clean_fn_decl_with_args(cx, sig.decl, args);
1025 TyMethodItem(Box::new(Function { decl, generics }))
1027 hir::TraitItemKind::Type(bounds, Some(default)) => {
1028 let generics = enter_impl_trait(cx, |cx| clean_generics(trait_item.generics, cx));
1029 let bounds = bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect();
1030 let item_type = clean_middle_ty(hir_ty_to_ty(cx.tcx, default), cx, None);
1033 type_: clean_ty(default, cx),
1035 item_type: Some(item_type),
1040 hir::TraitItemKind::Type(bounds, None) => {
1041 let generics = enter_impl_trait(cx, |cx| clean_generics(trait_item.generics, cx));
1042 let bounds = bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect();
1043 TyAssocTypeItem(Box::new(generics), bounds)
1046 let what_rustc_thinks =
1047 Item::from_def_id_and_parts(local_did, Some(trait_item.ident.name), inner, cx);
1048 // Trait items always inherit the trait's visibility -- we don't want to show `pub`.
1049 Item { visibility: Inherited, ..what_rustc_thinks }
1053 pub(crate) fn clean_impl_item<'tcx>(
1054 impl_: &hir::ImplItem<'tcx>,
1055 cx: &mut DocContext<'tcx>,
1057 let local_did = impl_.def_id.to_def_id();
1058 cx.with_param_env(local_did, |cx| {
1059 let inner = match impl_.kind {
1060 hir::ImplItemKind::Const(ty, expr) => {
1061 let default = ConstantKind::Local { def_id: local_did, body: expr };
1062 AssocConstItem(clean_ty(ty, cx), default)
1064 hir::ImplItemKind::Fn(ref sig, body) => {
1065 let m = clean_function(cx, sig, impl_.generics, body);
1066 let defaultness = cx.tcx.impl_defaultness(impl_.def_id);
1067 MethodItem(m, Some(defaultness))
1069 hir::ImplItemKind::TyAlias(hir_ty) => {
1070 let type_ = clean_ty(hir_ty, cx);
1071 let generics = clean_generics(impl_.generics, cx);
1072 let item_type = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1074 Box::new(Typedef { type_, generics, item_type: Some(item_type) }),
1080 let mut what_rustc_thinks =
1081 Item::from_def_id_and_parts(local_did, Some(impl_.ident.name), inner, cx);
1083 let impl_ref = cx.tcx.impl_trait_ref(cx.tcx.local_parent(impl_.def_id));
1085 // Trait impl items always inherit the impl's visibility --
1086 // we don't want to show `pub`.
1087 if impl_ref.is_some() {
1088 what_rustc_thinks.visibility = Inherited;
1095 pub(crate) fn clean_middle_assoc_item<'tcx>(
1096 assoc_item: &ty::AssocItem,
1097 cx: &mut DocContext<'tcx>,
1100 let kind = match assoc_item.kind {
1101 ty::AssocKind::Const => {
1102 let ty = clean_middle_ty(tcx.type_of(assoc_item.def_id), cx, Some(assoc_item.def_id));
1104 let provided = match assoc_item.container {
1105 ty::ImplContainer => true,
1106 ty::TraitContainer => tcx.impl_defaultness(assoc_item.def_id).has_value(),
1109 AssocConstItem(ty, ConstantKind::Extern { def_id: assoc_item.def_id })
1111 TyAssocConstItem(ty)
1114 ty::AssocKind::Fn => {
1115 let generics = clean_ty_generics(
1117 tcx.generics_of(assoc_item.def_id),
1118 tcx.explicit_predicates_of(assoc_item.def_id),
1120 let sig = tcx.fn_sig(assoc_item.def_id);
1121 let mut decl = clean_fn_decl_from_did_and_sig(cx, Some(assoc_item.def_id), sig);
1123 if assoc_item.fn_has_self_parameter {
1124 let self_ty = match assoc_item.container {
1125 ty::ImplContainer => tcx.type_of(assoc_item.container_id(tcx)),
1126 ty::TraitContainer => tcx.types.self_param,
1128 let self_arg_ty = sig.input(0).skip_binder();
1129 if self_arg_ty == self_ty {
1130 decl.inputs.values[0].type_ = Generic(kw::SelfUpper);
1131 } else if let ty::Ref(_, ty, _) = *self_arg_ty.kind() {
1133 match decl.inputs.values[0].type_ {
1134 BorrowedRef { ref mut type_, .. } => **type_ = Generic(kw::SelfUpper),
1135 _ => unreachable!(),
1141 let provided = match assoc_item.container {
1142 ty::ImplContainer => true,
1143 ty::TraitContainer => assoc_item.defaultness(tcx).has_value(),
1146 let defaultness = match assoc_item.container {
1147 ty::ImplContainer => Some(assoc_item.defaultness(tcx)),
1148 ty::TraitContainer => None,
1150 MethodItem(Box::new(Function { generics, decl }), defaultness)
1152 TyMethodItem(Box::new(Function { generics, decl }))
1155 ty::AssocKind::Type => {
1156 let my_name = assoc_item.name;
1158 fn param_eq_arg(param: &GenericParamDef, arg: &GenericArg) -> bool {
1159 match (¶m.kind, arg) {
1160 (GenericParamDefKind::Type { .. }, GenericArg::Type(Type::Generic(ty)))
1161 if *ty == param.name =>
1165 (GenericParamDefKind::Lifetime { .. }, GenericArg::Lifetime(Lifetime(lt)))
1166 if *lt == param.name =>
1170 (GenericParamDefKind::Const { .. }, GenericArg::Const(c)) => match &c.kind {
1171 ConstantKind::TyConst { expr } => expr == param.name.as_str(),
1178 if let ty::TraitContainer = assoc_item.container {
1179 let bounds = tcx.explicit_item_bounds(assoc_item.def_id);
1180 let predicates = ty::GenericPredicates { parent: None, predicates: bounds };
1182 clean_ty_generics(cx, tcx.generics_of(assoc_item.def_id), predicates);
1183 // Filter out the bounds that are (likely?) directly attached to the associated type,
1184 // as opposed to being located in the where clause.
1185 let mut bounds = generics
1187 .drain_filter(|pred| match *pred {
1188 WherePredicate::BoundPredicate {
1189 ty: QPath { ref assoc, ref self_type, ref trait_, .. },
1192 if assoc.name != my_name {
1195 if trait_.def_id() != assoc_item.container_id(tcx) {
1199 Generic(ref s) if *s == kw::SelfUpper => {}
1203 GenericArgs::AngleBracketed { args, bindings } => {
1204 if !bindings.is_empty()
1209 .any(|(param, arg)| !param_eq_arg(param, arg))
1214 GenericArgs::Parenthesized { .. } => {
1215 // The only time this happens is if we're inside the rustdoc for Fn(),
1216 // which only has one associated type, which is not a GAT, so whatever.
1224 if let WherePredicate::BoundPredicate { bounds, .. } = pred {
1230 .collect::<Vec<_>>();
1231 // Our Sized/?Sized bound didn't get handled when creating the generics
1232 // because we didn't actually get our whole set of bounds until just now
1233 // (some of them may have come from the trait). If we do have a sized
1234 // bound, we remove it, and if we don't then we add the `?Sized` bound
1236 match bounds.iter().position(|b| b.is_sized_bound(cx)) {
1240 None => bounds.push(GenericBound::maybe_sized(cx)),
1243 if tcx.impl_defaultness(assoc_item.def_id).has_value() {
1246 type_: clean_middle_ty(
1247 tcx.type_of(assoc_item.def_id),
1249 Some(assoc_item.def_id),
1252 // FIXME: should we obtain the Type from HIR and pass it on here?
1258 TyAssocTypeItem(Box::new(generics), bounds)
1261 // FIXME: when could this happen? Associated items in inherent impls?
1264 type_: clean_middle_ty(
1265 tcx.type_of(assoc_item.def_id),
1267 Some(assoc_item.def_id),
1269 generics: Generics { params: Vec::new(), where_predicates: Vec::new() },
1278 let mut what_rustc_thinks =
1279 Item::from_def_id_and_parts(assoc_item.def_id, Some(assoc_item.name), kind, cx);
1281 let impl_ref = tcx.impl_trait_ref(tcx.parent(assoc_item.def_id));
1283 // Trait impl items always inherit the impl's visibility --
1284 // we don't want to show `pub`.
1285 if impl_ref.is_some() {
1286 what_rustc_thinks.visibility = Visibility::Inherited;
1292 fn clean_qpath<'tcx>(hir_ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1293 let hir::Ty { hir_id: _, span, ref kind } = *hir_ty;
1294 let hir::TyKind::Path(qpath) = kind else { unreachable!() };
1297 hir::QPath::Resolved(None, path) => {
1298 if let Res::Def(DefKind::TyParam, did) = path.res {
1299 if let Some(new_ty) = cx.substs.get(&did).and_then(|p| p.as_ty()).cloned() {
1302 if let Some(bounds) = cx.impl_trait_bounds.remove(&did.into()) {
1303 return ImplTrait(bounds);
1307 if let Some(expanded) = maybe_expand_private_type_alias(cx, path) {
1310 let path = clean_path(path, cx);
1311 resolve_type(cx, path)
1314 hir::QPath::Resolved(Some(qself), p) => {
1315 // Try to normalize `<X as Y>::T` to a type
1316 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1317 if let Some(normalized_value) = normalize(cx, ty) {
1318 return clean_middle_ty(normalized_value, cx, None);
1321 let trait_segments = &p.segments[..p.segments.len() - 1];
1322 let trait_def = cx.tcx.associated_item(p.res.def_id()).container_id(cx.tcx);
1323 let trait_ = self::Path {
1324 res: Res::Def(DefKind::Trait, trait_def),
1325 segments: trait_segments.iter().map(|x| clean_path_segment(x, cx)).collect(),
1327 register_res(cx, trait_.res);
1328 let self_def_id = DefId::local(qself.hir_id.owner.local_def_index);
1329 let self_type = clean_ty(qself, cx);
1330 let should_show_cast = compute_should_show_cast(Some(self_def_id), &trait_, &self_type);
1332 assoc: Box::new(clean_path_segment(
1333 p.segments.last().expect("segments were empty"),
1337 self_type: Box::new(self_type),
1341 hir::QPath::TypeRelative(qself, segment) => {
1342 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1343 let res = match ty.kind() {
1344 ty::Projection(proj) => Res::Def(DefKind::Trait, proj.trait_ref(cx.tcx).def_id),
1345 // Rustdoc handles `ty::Error`s by turning them into `Type::Infer`s.
1346 ty::Error(_) => return Type::Infer,
1347 _ => bug!("clean: expected associated type, found `{:?}`", ty),
1349 let trait_ = clean_path(&hir::Path { span, res, segments: &[] }, cx);
1350 register_res(cx, trait_.res);
1351 let self_def_id = res.opt_def_id();
1352 let self_type = clean_ty(qself, cx);
1353 let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
1355 assoc: Box::new(clean_path_segment(segment, cx)),
1357 self_type: Box::new(self_type),
1361 hir::QPath::LangItem(..) => bug!("clean: requiring documentation of lang item"),
1365 fn maybe_expand_private_type_alias<'tcx>(
1366 cx: &mut DocContext<'tcx>,
1367 path: &hir::Path<'tcx>,
1369 let Res::Def(DefKind::TyAlias, def_id) = path.res else { return None };
1370 // Substitute private type aliases
1371 let def_id = def_id.as_local()?;
1372 let alias = if !cx.cache.access_levels.is_exported(def_id.to_def_id()) {
1373 &cx.tcx.hir().expect_item(def_id).kind
1377 let hir::ItemKind::TyAlias(ty, generics) = alias else { return None };
1379 let provided_params = &path.segments.last().expect("segments were empty");
1380 let mut substs = FxHashMap::default();
1381 let generic_args = provided_params.args();
1383 let mut indices: hir::GenericParamCount = Default::default();
1384 for param in generics.params.iter() {
1386 hir::GenericParamKind::Lifetime { .. } => {
1388 let lifetime = generic_args.args.iter().find_map(|arg| match arg {
1389 hir::GenericArg::Lifetime(lt) => {
1390 if indices.lifetimes == j {
1398 if let Some(lt) = lifetime.cloned() {
1399 let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1401 if !lt.is_elided() { clean_lifetime(lt, cx) } else { Lifetime::elided() };
1402 substs.insert(lt_def_id.to_def_id(), SubstParam::Lifetime(cleaned));
1404 indices.lifetimes += 1;
1406 hir::GenericParamKind::Type { ref default, .. } => {
1407 let ty_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1409 let type_ = generic_args.args.iter().find_map(|arg| match arg {
1410 hir::GenericArg::Type(ty) => {
1411 if indices.types == j {
1419 if let Some(ty) = type_ {
1420 substs.insert(ty_param_def_id.to_def_id(), SubstParam::Type(clean_ty(ty, cx)));
1421 } else if let Some(default) = *default {
1423 ty_param_def_id.to_def_id(),
1424 SubstParam::Type(clean_ty(default, cx)),
1429 hir::GenericParamKind::Const { .. } => {
1430 let const_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1432 let const_ = generic_args.args.iter().find_map(|arg| match arg {
1433 hir::GenericArg::Const(ct) => {
1434 if indices.consts == j {
1442 if let Some(ct) = const_ {
1444 const_param_def_id.to_def_id(),
1445 SubstParam::Constant(clean_const(ct, cx)),
1448 // FIXME(const_generics_defaults)
1449 indices.consts += 1;
1454 Some(cx.enter_alias(substs, |cx| clean_ty(ty, cx)))
1457 pub(crate) fn clean_ty<'tcx>(ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1461 TyKind::Never => Primitive(PrimitiveType::Never),
1462 TyKind::Ptr(ref m) => RawPointer(m.mutbl, Box::new(clean_ty(m.ty, cx))),
1463 TyKind::Rptr(ref l, ref m) => {
1464 // There are two times a `Fresh` lifetime can be created:
1465 // 1. For `&'_ x`, written by the user. This corresponds to `lower_lifetime` in `rustc_ast_lowering`.
1466 // 2. For `&x` as a parameter to an `async fn`. This corresponds to `elided_ref_lifetime in `rustc_ast_lowering`.
1467 // See #59286 for more information.
1468 // Ideally we would only hide the `'_` for case 2., but I don't know a way to distinguish it.
1469 // Turning `fn f(&'_ self)` into `fn f(&self)` isn't the worst thing in the world, though;
1470 // there's no case where it could cause the function to fail to compile.
1472 l.is_elided() || matches!(l.name, LifetimeName::Param(_, ParamName::Fresh));
1473 let lifetime = if elided { None } else { Some(clean_lifetime(*l, cx)) };
1474 BorrowedRef { lifetime, mutability: m.mutbl, type_: Box::new(clean_ty(m.ty, cx)) }
1476 TyKind::Slice(ty) => Slice(Box::new(clean_ty(ty, cx))),
1477 TyKind::Array(ty, ref length) => {
1478 let length = match length {
1479 hir::ArrayLen::Infer(_, _) => "_".to_string(),
1480 hir::ArrayLen::Body(anon_const) => {
1481 let def_id = cx.tcx.hir().local_def_id(anon_const.hir_id);
1482 // NOTE(min_const_generics): We can't use `const_eval_poly` for constants
1483 // as we currently do not supply the parent generics to anonymous constants
1484 // but do allow `ConstKind::Param`.
1486 // `const_eval_poly` tries to to first substitute generic parameters which
1487 // results in an ICE while manually constructing the constant and using `eval`
1488 // does nothing for `ConstKind::Param`.
1489 let ct = ty::Const::from_anon_const(cx.tcx, def_id);
1490 let param_env = cx.tcx.param_env(def_id);
1491 print_const(cx, ct.eval(cx.tcx, param_env))
1495 Array(Box::new(clean_ty(ty, cx)), length)
1497 TyKind::Tup(tys) => Tuple(tys.iter().map(|ty| clean_ty(ty, cx)).collect()),
1498 TyKind::OpaqueDef(item_id, _) => {
1499 let item = cx.tcx.hir().item(item_id);
1500 if let hir::ItemKind::OpaqueTy(ref ty) = item.kind {
1501 ImplTrait(ty.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect())
1506 TyKind::Path(_) => clean_qpath(ty, cx),
1507 TyKind::TraitObject(bounds, ref lifetime, _) => {
1508 let bounds = bounds.iter().map(|bound| clean_poly_trait_ref(bound, cx)).collect();
1510 if !lifetime.is_elided() { Some(clean_lifetime(*lifetime, cx)) } else { None };
1511 DynTrait(bounds, lifetime)
1513 TyKind::BareFn(barefn) => BareFunction(Box::new(clean_bare_fn_ty(barefn, cx))),
1514 // Rustdoc handles `TyKind::Err`s by turning them into `Type::Infer`s.
1515 TyKind::Infer | TyKind::Err => Infer,
1516 TyKind::Typeof(..) => panic!("unimplemented type {:?}", ty.kind),
1520 /// Returns `None` if the type could not be normalized
1521 fn normalize<'tcx>(cx: &mut DocContext<'tcx>, ty: Ty<'_>) -> Option<Ty<'tcx>> {
1522 // HACK: low-churn fix for #79459 while we wait for a trait normalization fix
1523 if !cx.tcx.sess.opts.unstable_opts.normalize_docs {
1527 use crate::rustc_trait_selection::infer::TyCtxtInferExt;
1528 use crate::rustc_trait_selection::traits::query::normalize::AtExt;
1529 use rustc_middle::traits::ObligationCause;
1531 // Try to normalize `<X as Y>::T` to a type
1532 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
1533 let normalized = cx.tcx.infer_ctxt().enter(|infcx| {
1535 .at(&ObligationCause::dummy(), cx.param_env)
1537 .map(|resolved| infcx.resolve_vars_if_possible(resolved.value))
1540 Ok(normalized_value) => {
1541 debug!("normalized {:?} to {:?}", ty, normalized_value);
1542 Some(normalized_value)
1545 debug!("failed to normalize {:?}: {:?}", ty, err);
1551 pub(crate) fn clean_middle_ty<'tcx>(
1553 cx: &mut DocContext<'tcx>,
1554 def_id: Option<DefId>,
1556 trace!("cleaning type: {:?}", this);
1557 let ty = normalize(cx, this).unwrap_or(this);
1559 ty::Never => Primitive(PrimitiveType::Never),
1560 ty::Bool => Primitive(PrimitiveType::Bool),
1561 ty::Char => Primitive(PrimitiveType::Char),
1562 ty::Int(int_ty) => Primitive(int_ty.into()),
1563 ty::Uint(uint_ty) => Primitive(uint_ty.into()),
1564 ty::Float(float_ty) => Primitive(float_ty.into()),
1565 ty::Str => Primitive(PrimitiveType::Str),
1566 ty::Slice(ty) => Slice(Box::new(clean_middle_ty(ty, cx, None))),
1567 ty::Array(ty, n) => {
1568 let mut n = cx.tcx.lift(n).expect("array lift failed");
1569 n = n.eval(cx.tcx, ty::ParamEnv::reveal_all());
1570 let n = print_const(cx, n);
1571 Array(Box::new(clean_middle_ty(ty, cx, None)), n)
1573 ty::RawPtr(mt) => RawPointer(mt.mutbl, Box::new(clean_middle_ty(mt.ty, cx, None))),
1574 ty::Ref(r, ty, mutbl) => BorrowedRef {
1575 lifetime: clean_middle_region(r),
1577 type_: Box::new(clean_middle_ty(ty, cx, None)),
1579 ty::FnDef(..) | ty::FnPtr(_) => {
1580 let ty = cx.tcx.lift(this).expect("FnPtr lift failed");
1581 let sig = ty.fn_sig(cx.tcx);
1582 let decl = clean_fn_decl_from_did_and_sig(cx, None, sig);
1583 BareFunction(Box::new(BareFunctionDecl {
1584 unsafety: sig.unsafety(),
1585 generic_params: Vec::new(),
1590 ty::Adt(def, substs) => {
1591 let did = def.did();
1592 let kind = match def.adt_kind() {
1593 AdtKind::Struct => ItemType::Struct,
1594 AdtKind::Union => ItemType::Union,
1595 AdtKind::Enum => ItemType::Enum,
1597 inline::record_extern_fqn(cx, did, kind);
1598 let path = external_path(cx, did, false, vec![], substs);
1601 ty::Foreign(did) => {
1602 inline::record_extern_fqn(cx, did, ItemType::ForeignType);
1603 let path = external_path(cx, did, false, vec![], InternalSubsts::empty());
1606 ty::Dynamic(obj, ref reg) => {
1607 // HACK: pick the first `did` as the `did` of the trait object. Someone
1608 // might want to implement "native" support for marker-trait-only
1610 let mut dids = obj.auto_traits();
1613 .or_else(|| dids.next())
1614 .unwrap_or_else(|| panic!("found trait object `{:?}` with no traits?", this));
1615 let substs = match obj.principal() {
1616 Some(principal) => principal.skip_binder().substs,
1617 // marker traits have no substs.
1618 _ => cx.tcx.intern_substs(&[]),
1621 inline::record_extern_fqn(cx, did, ItemType::Trait);
1623 let lifetime = clean_middle_region(*reg);
1624 let mut bounds = dids
1626 let empty = cx.tcx.intern_substs(&[]);
1627 let path = external_path(cx, did, false, vec![], empty);
1628 inline::record_extern_fqn(cx, did, ItemType::Trait);
1629 PolyTrait { trait_: path, generic_params: Vec::new() }
1631 .collect::<Vec<_>>();
1634 .projection_bounds()
1635 .map(|pb| TypeBinding {
1636 assoc: projection_to_path_segment(
1638 .lift_to_tcx(cx.tcx)
1640 // HACK(compiler-errors): Doesn't actually matter what self
1641 // type we put here, because we're only using the GAT's substs.
1642 .with_self_ty(cx.tcx, cx.tcx.types.self_param)
1646 kind: TypeBindingKind::Equality {
1647 term: clean_middle_term(pb.skip_binder().term, cx),
1652 let path = external_path(cx, did, false, bindings, substs);
1653 bounds.insert(0, PolyTrait { trait_: path, generic_params: Vec::new() });
1655 DynTrait(bounds, lifetime)
1657 ty::Tuple(t) => Tuple(t.iter().map(|t| clean_middle_ty(t, cx, None)).collect()),
1659 ty::Projection(ref data) => clean_projection(*data, cx, def_id),
1661 ty::Param(ref p) => {
1662 if let Some(bounds) = cx.impl_trait_bounds.remove(&p.index.into()) {
1669 ty::Opaque(def_id, substs) => {
1670 // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
1671 // by looking up the bounds associated with the def_id.
1672 let substs = cx.tcx.lift(substs).expect("Opaque lift failed");
1675 .explicit_item_bounds(def_id)
1677 .map(|(bound, _)| EarlyBinder(*bound).subst(cx.tcx, substs))
1678 .collect::<Vec<_>>();
1679 let mut regions = vec![];
1680 let mut has_sized = false;
1681 let mut bounds = bounds
1683 .filter_map(|bound| {
1684 let bound_predicate = bound.kind();
1685 let trait_ref = match bound_predicate.skip_binder() {
1686 ty::PredicateKind::Trait(tr) => bound_predicate.rebind(tr.trait_ref),
1687 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(_ty, reg)) => {
1688 if let Some(r) = clean_middle_region(reg) {
1689 regions.push(GenericBound::Outlives(r));
1696 if let Some(sized) = cx.tcx.lang_items().sized_trait() {
1697 if trait_ref.def_id() == sized {
1703 let bindings: Vec<_> = bounds
1705 .filter_map(|bound| {
1706 if let ty::PredicateKind::Projection(proj) = bound.kind().skip_binder()
1708 if proj.projection_ty.trait_ref(cx.tcx) == trait_ref.skip_binder() {
1710 assoc: projection_to_path_segment(proj.projection_ty, cx),
1711 kind: TypeBindingKind::Equality {
1712 term: clean_middle_term(proj.term, cx),
1724 Some(clean_poly_trait_ref_with_bindings(cx, trait_ref, &bindings))
1726 .collect::<Vec<_>>();
1727 bounds.extend(regions);
1728 if !has_sized && !bounds.is_empty() {
1729 bounds.insert(0, GenericBound::maybe_sized(cx));
1734 ty::Closure(..) => panic!("Closure"),
1735 ty::Generator(..) => panic!("Generator"),
1736 ty::Bound(..) => panic!("Bound"),
1737 ty::Placeholder(..) => panic!("Placeholder"),
1738 ty::GeneratorWitness(..) => panic!("GeneratorWitness"),
1739 ty::Infer(..) => panic!("Infer"),
1740 ty::Error(_) => panic!("Error"),
1744 pub(crate) fn clean_field<'tcx>(field: &hir::FieldDef<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1745 let def_id = cx.tcx.hir().local_def_id(field.hir_id).to_def_id();
1746 clean_field_with_def_id(def_id, field.ident.name, clean_ty(field.ty, cx), cx)
1749 pub(crate) fn clean_middle_field<'tcx>(field: &ty::FieldDef, cx: &mut DocContext<'tcx>) -> Item {
1750 clean_field_with_def_id(
1753 clean_middle_ty(cx.tcx.type_of(field.did), cx, Some(field.did)),
1758 pub(crate) fn clean_field_with_def_id(
1762 cx: &mut DocContext<'_>,
1764 let what_rustc_thinks =
1765 Item::from_def_id_and_parts(def_id, Some(name), StructFieldItem(ty), cx);
1766 if is_field_vis_inherited(cx.tcx, def_id) {
1767 // Variant fields inherit their enum's visibility.
1768 Item { visibility: Visibility::Inherited, ..what_rustc_thinks }
1774 fn is_field_vis_inherited(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1775 let parent = tcx.parent(def_id);
1776 match tcx.def_kind(parent) {
1777 DefKind::Struct | DefKind::Union => false,
1778 DefKind::Variant => true,
1779 parent_kind => panic!("unexpected parent kind: {:?}", parent_kind),
1783 pub(crate) fn clean_visibility(vis: ty::Visibility) -> Visibility {
1785 ty::Visibility::Public => Visibility::Public,
1786 // NOTE: this is not quite right: `ty` uses `Invisible` to mean 'private',
1787 // while rustdoc really does mean inherited. That means that for enum variants, such as
1788 // `pub enum E { V }`, `V` will be marked as `Public` by `ty`, but as `Inherited` by rustdoc.
1789 // Various parts of clean override `tcx.visibility` explicitly to make sure this distinction is captured.
1790 ty::Visibility::Invisible => Visibility::Inherited,
1791 ty::Visibility::Restricted(module) => Visibility::Restricted(module),
1795 pub(crate) fn clean_variant_def<'tcx>(variant: &ty::VariantDef, cx: &mut DocContext<'tcx>) -> Item {
1796 let kind = match variant.ctor_kind {
1797 CtorKind::Const => Variant::CLike,
1798 CtorKind::Fn => Variant::Tuple(
1799 variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1801 CtorKind::Fictive => Variant::Struct(VariantStruct {
1802 struct_type: CtorKind::Fictive,
1803 fields: variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1806 let what_rustc_thinks =
1807 Item::from_def_id_and_parts(variant.def_id, Some(variant.name), VariantItem(kind), cx);
1808 // don't show `pub` for variants, which always inherit visibility
1809 Item { visibility: Inherited, ..what_rustc_thinks }
1812 fn clean_variant_data<'tcx>(
1813 variant: &hir::VariantData<'tcx>,
1814 cx: &mut DocContext<'tcx>,
1817 hir::VariantData::Struct(..) => Variant::Struct(VariantStruct {
1818 struct_type: CtorKind::from_hir(variant),
1819 fields: variant.fields().iter().map(|x| clean_field(x, cx)).collect(),
1821 hir::VariantData::Tuple(..) => {
1822 Variant::Tuple(variant.fields().iter().map(|x| clean_field(x, cx)).collect())
1824 hir::VariantData::Unit(..) => Variant::CLike,
1828 fn clean_path<'tcx>(path: &hir::Path<'tcx>, cx: &mut DocContext<'tcx>) -> Path {
1831 segments: path.segments.iter().map(|x| clean_path_segment(x, cx)).collect(),
1835 fn clean_generic_args<'tcx>(
1836 generic_args: &hir::GenericArgs<'tcx>,
1837 cx: &mut DocContext<'tcx>,
1839 if generic_args.parenthesized {
1840 let output = clean_ty(generic_args.bindings[0].ty(), cx);
1841 let output = if output != Type::Tuple(Vec::new()) { Some(Box::new(output)) } else { None };
1843 generic_args.inputs().iter().map(|x| clean_ty(x, cx)).collect::<Vec<_>>().into();
1844 GenericArgs::Parenthesized { inputs, output }
1846 let args = generic_args
1849 .map(|arg| match arg {
1850 hir::GenericArg::Lifetime(lt) if !lt.is_elided() => {
1851 GenericArg::Lifetime(clean_lifetime(*lt, cx))
1853 hir::GenericArg::Lifetime(_) => GenericArg::Lifetime(Lifetime::elided()),
1854 hir::GenericArg::Type(ty) => GenericArg::Type(clean_ty(ty, cx)),
1855 hir::GenericArg::Const(ct) => GenericArg::Const(Box::new(clean_const(ct, cx))),
1856 hir::GenericArg::Infer(_inf) => GenericArg::Infer,
1858 .collect::<Vec<_>>()
1860 let bindings = generic_args
1863 .map(|x| clean_type_binding(x, cx))
1864 .collect::<Vec<_>>()
1866 GenericArgs::AngleBracketed { args, bindings }
1870 fn clean_path_segment<'tcx>(
1871 path: &hir::PathSegment<'tcx>,
1872 cx: &mut DocContext<'tcx>,
1874 PathSegment { name: path.ident.name, args: clean_generic_args(path.args(), cx) }
1877 fn clean_bare_fn_ty<'tcx>(
1878 bare_fn: &hir::BareFnTy<'tcx>,
1879 cx: &mut DocContext<'tcx>,
1880 ) -> BareFunctionDecl {
1881 let (generic_params, decl) = enter_impl_trait(cx, |cx| {
1882 // NOTE: generics must be cleaned before args
1883 let generic_params = bare_fn
1886 .filter(|p| !is_elided_lifetime(p))
1887 .map(|x| clean_generic_param(cx, None, x))
1889 let args = clean_args_from_types_and_names(cx, bare_fn.decl.inputs, bare_fn.param_names);
1890 let decl = clean_fn_decl_with_args(cx, bare_fn.decl, args);
1891 (generic_params, decl)
1893 BareFunctionDecl { unsafety: bare_fn.unsafety, abi: bare_fn.abi, decl, generic_params }
1896 fn clean_maybe_renamed_item<'tcx>(
1897 cx: &mut DocContext<'tcx>,
1898 item: &hir::Item<'tcx>,
1899 renamed: Option<Symbol>,
1903 let def_id = item.def_id.to_def_id();
1904 let mut name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
1905 cx.with_param_env(def_id, |cx| {
1906 let kind = match item.kind {
1907 ItemKind::Static(ty, mutability, body_id) => {
1908 StaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: Some(body_id) })
1910 ItemKind::Const(ty, body_id) => ConstantItem(Constant {
1911 type_: clean_ty(ty, cx),
1912 kind: ConstantKind::Local { body: body_id, def_id },
1914 ItemKind::OpaqueTy(ref ty) => OpaqueTyItem(OpaqueTy {
1915 bounds: ty.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1916 generics: clean_generics(ty.generics, cx),
1918 ItemKind::TyAlias(hir_ty, generics) => {
1919 let rustdoc_ty = clean_ty(hir_ty, cx);
1920 let ty = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1921 TypedefItem(Box::new(Typedef {
1923 generics: clean_generics(generics, cx),
1924 item_type: Some(ty),
1927 ItemKind::Enum(ref def, generics) => EnumItem(Enum {
1928 variants: def.variants.iter().map(|v| v.clean(cx)).collect(),
1929 generics: clean_generics(generics, cx),
1931 ItemKind::TraitAlias(generics, bounds) => TraitAliasItem(TraitAlias {
1932 generics: clean_generics(generics, cx),
1933 bounds: bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1935 ItemKind::Union(ref variant_data, generics) => UnionItem(Union {
1936 generics: clean_generics(generics, cx),
1937 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1939 ItemKind::Struct(ref variant_data, generics) => StructItem(Struct {
1940 struct_type: CtorKind::from_hir(variant_data),
1941 generics: clean_generics(generics, cx),
1942 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1944 ItemKind::Impl(impl_) => return clean_impl(impl_, item.hir_id(), cx),
1945 // proc macros can have a name set by attributes
1946 ItemKind::Fn(ref sig, generics, body_id) => {
1947 clean_fn_or_proc_macro(item, sig, generics, body_id, &mut name, cx)
1949 ItemKind::Macro(ref macro_def, _) => {
1950 let ty_vis = clean_visibility(cx.tcx.visibility(def_id));
1952 source: display_macro_source(cx, name, macro_def, def_id, ty_vis),
1955 ItemKind::Trait(_, _, generics, bounds, item_ids) => {
1956 let items = item_ids
1958 .map(|ti| clean_trait_item(cx.tcx.hir().trait_item(ti.id), cx))
1964 generics: clean_generics(generics, cx),
1965 bounds: bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1968 ItemKind::ExternCrate(orig_name) => {
1969 return clean_extern_crate(item, name, orig_name, cx);
1971 ItemKind::Use(path, kind) => {
1972 return clean_use_statement(item, name, path, kind, cx, &mut FxHashSet::default());
1974 _ => unreachable!("not yet converted"),
1977 vec![Item::from_def_id_and_parts(def_id, Some(name), kind, cx)]
1981 impl<'tcx> Clean<'tcx, Item> for hir::Variant<'tcx> {
1982 fn clean(&self, cx: &mut DocContext<'tcx>) -> Item {
1983 let kind = VariantItem(clean_variant_data(&self.data, cx));
1984 let what_rustc_thinks =
1985 Item::from_hir_id_and_parts(self.id, Some(self.ident.name), kind, cx);
1986 // don't show `pub` for variants, which are always public
1987 Item { visibility: Inherited, ..what_rustc_thinks }
1991 fn clean_impl<'tcx>(
1992 impl_: &hir::Impl<'tcx>,
1994 cx: &mut DocContext<'tcx>,
1997 let mut ret = Vec::new();
1998 let trait_ = impl_.of_trait.as_ref().map(|t| clean_trait_ref(t, cx));
2002 .map(|ii| clean_impl_item(tcx.hir().impl_item(ii.id), cx))
2003 .collect::<Vec<_>>();
2004 let def_id = tcx.hir().local_def_id(hir_id);
2006 // If this impl block is an implementation of the Deref trait, then we
2007 // need to try inlining the target's inherent impl blocks as well.
2008 if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
2009 build_deref_target_impls(cx, &items, &mut ret);
2012 let for_ = clean_ty(impl_.self_ty, cx);
2013 let type_alias = for_.def_id(&cx.cache).and_then(|did| match tcx.def_kind(did) {
2014 DefKind::TyAlias => Some(clean_middle_ty(tcx.type_of(did), cx, Some(did))),
2017 let mut make_item = |trait_: Option<Path>, for_: Type, items: Vec<Item>| {
2018 let kind = ImplItem(Box::new(Impl {
2019 unsafety: impl_.unsafety,
2020 generics: clean_generics(impl_.generics, cx),
2024 polarity: tcx.impl_polarity(def_id),
2025 kind: if utils::has_doc_flag(tcx, def_id.to_def_id(), sym::fake_variadic) {
2026 ImplKind::FakeVaradic
2031 Item::from_hir_id_and_parts(hir_id, None, kind, cx)
2033 if let Some(type_alias) = type_alias {
2034 ret.push(make_item(trait_.clone(), type_alias, items.clone()));
2036 ret.push(make_item(trait_, for_, items));
2040 fn clean_extern_crate<'tcx>(
2041 krate: &hir::Item<'tcx>,
2043 orig_name: Option<Symbol>,
2044 cx: &mut DocContext<'tcx>,
2046 // this is the ID of the `extern crate` statement
2047 let cnum = cx.tcx.extern_mod_stmt_cnum(krate.def_id).unwrap_or(LOCAL_CRATE);
2048 // this is the ID of the crate itself
2049 let crate_def_id = cnum.as_def_id();
2050 let attrs = cx.tcx.hir().attrs(krate.hir_id());
2051 let ty_vis = cx.tcx.visibility(krate.def_id);
2052 let please_inline = ty_vis.is_public()
2053 && attrs.iter().any(|a| {
2054 a.has_name(sym::doc)
2055 && match a.meta_item_list() {
2056 Some(l) => attr::list_contains_name(&l, sym::inline),
2062 let mut visited = FxHashSet::default();
2064 let res = Res::Def(DefKind::Mod, crate_def_id);
2066 if let Some(items) = inline::try_inline(
2068 cx.tcx.parent_module(krate.hir_id()).to_def_id(),
2069 Some(krate.def_id.to_def_id()),
2079 // FIXME: using `from_def_id_and_kind` breaks `rustdoc/masked` for some reason
2082 attrs: Box::new(Attributes::from_ast(attrs)),
2083 item_id: crate_def_id.into(),
2084 visibility: clean_visibility(ty_vis),
2085 kind: Box::new(ExternCrateItem { src: orig_name }),
2086 cfg: attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
2090 fn clean_use_statement<'tcx>(
2091 import: &hir::Item<'tcx>,
2093 path: &hir::Path<'tcx>,
2095 cx: &mut DocContext<'tcx>,
2096 inlined_names: &mut FxHashSet<(ItemType, Symbol)>,
2098 // We need this comparison because some imports (for std types for example)
2099 // are "inserted" as well but directly by the compiler and they should not be
2100 // taken into account.
2101 if import.span.ctxt().outer_expn_data().kind == ExpnKind::AstPass(AstPass::StdImports) {
2105 let visibility = cx.tcx.visibility(import.def_id);
2106 let attrs = cx.tcx.hir().attrs(import.hir_id());
2107 let inline_attr = attrs.lists(sym::doc).get_word_attr(sym::inline);
2108 let pub_underscore = visibility.is_public() && name == kw::Underscore;
2109 let current_mod = cx.tcx.parent_module_from_def_id(import.def_id);
2111 // The parent of the module in which this import resides. This
2112 // is the same as `current_mod` if that's already the top
2114 let parent_mod = cx.tcx.parent_module_from_def_id(current_mod);
2116 // This checks if the import can be seen from a higher level module.
2117 // In other words, it checks if the visibility is the equivalent of
2118 // `pub(super)` or higher. If the current module is the top level
2119 // module, there isn't really a parent module, which makes the results
2120 // meaningless. In this case, we make sure the answer is `false`.
2121 let is_visible_from_parent_mod = visibility.is_accessible_from(parent_mod.to_def_id(), cx.tcx)
2122 && !current_mod.is_top_level_module();
2125 if let Some(ref inline) = inline_attr {
2126 rustc_errors::struct_span_err!(
2130 "anonymous imports cannot be inlined"
2132 .span_label(import.span, "anonymous import")
2137 // We consider inlining the documentation of `pub use` statements, but we
2138 // forcefully don't inline if this is not public or if the
2139 // #[doc(no_inline)] attribute is present.
2140 // Don't inline doc(hidden) imports so they can be stripped at a later stage.
2141 let mut denied = cx.output_format.is_json()
2142 || !(visibility.is_public()
2143 || (cx.render_options.document_private && is_visible_from_parent_mod))
2145 || attrs.iter().any(|a| {
2146 a.has_name(sym::doc)
2147 && match a.meta_item_list() {
2149 attr::list_contains_name(&l, sym::no_inline)
2150 || attr::list_contains_name(&l, sym::hidden)
2156 // Also check whether imports were asked to be inlined, in case we're trying to re-export a
2157 // crate in Rust 2018+
2158 let path = clean_path(path, cx);
2159 let inner = if kind == hir::UseKind::Glob {
2161 let mut visited = FxHashSet::default();
2162 if let Some(items) = inline::try_inline_glob(cx, path.res, &mut visited, inlined_names)
2167 Import::new_glob(resolve_use_source(cx, path), true)
2169 if inline_attr.is_none() {
2170 if let Res::Def(DefKind::Mod, did) = path.res {
2171 if !did.is_local() && did.is_crate_root() {
2172 // if we're `pub use`ing an extern crate root, don't inline it unless we
2173 // were specifically asked for it
2179 let mut visited = FxHashSet::default();
2180 let import_def_id = import.def_id.to_def_id();
2182 if let Some(mut items) = inline::try_inline(
2184 cx.tcx.parent_module(import.hir_id()).to_def_id(),
2185 Some(import_def_id),
2191 items.push(Item::from_def_id_and_parts(
2194 ImportItem(Import::new_simple(name, resolve_use_source(cx, path), false)),
2200 Import::new_simple(name, resolve_use_source(cx, path), true)
2203 vec![Item::from_def_id_and_parts(import.def_id.to_def_id(), None, ImportItem(inner), cx)]
2206 fn clean_maybe_renamed_foreign_item<'tcx>(
2207 cx: &mut DocContext<'tcx>,
2208 item: &hir::ForeignItem<'tcx>,
2209 renamed: Option<Symbol>,
2211 let def_id = item.def_id.to_def_id();
2212 cx.with_param_env(def_id, |cx| {
2213 let kind = match item.kind {
2214 hir::ForeignItemKind::Fn(decl, names, generics) => {
2215 let (generics, decl) = enter_impl_trait(cx, |cx| {
2216 // NOTE: generics must be cleaned before args
2217 let generics = clean_generics(generics, cx);
2218 let args = clean_args_from_types_and_names(cx, decl.inputs, names);
2219 let decl = clean_fn_decl_with_args(cx, decl, args);
2222 ForeignFunctionItem(Box::new(Function { decl, generics }))
2224 hir::ForeignItemKind::Static(ty, mutability) => {
2225 ForeignStaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: None })
2227 hir::ForeignItemKind::Type => ForeignTypeItem,
2230 Item::from_hir_id_and_parts(
2232 Some(renamed.unwrap_or(item.ident.name)),
2239 fn clean_type_binding<'tcx>(
2240 type_binding: &hir::TypeBinding<'tcx>,
2241 cx: &mut DocContext<'tcx>,
2244 assoc: PathSegment {
2245 name: type_binding.ident.name,
2246 args: clean_generic_args(type_binding.gen_args, cx),
2248 kind: match type_binding.kind {
2249 hir::TypeBindingKind::Equality { ref term } => {
2250 TypeBindingKind::Equality { term: clean_hir_term(term, cx) }
2252 hir::TypeBindingKind::Constraint { bounds } => TypeBindingKind::Constraint {
2253 bounds: bounds.iter().filter_map(|b| clean_generic_bound(b, cx)).collect(),