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 impl<'tcx> Clean<'tcx, Item> for DocModule<'tcx> {
52 fn clean(&self, cx: &mut DocContext<'tcx>) -> Item {
53 let mut items: Vec<Item> = vec![];
57 .map(|(item, renamed)| clean_maybe_renamed_foreign_item(cx, item, *renamed)),
59 items.extend(self.mods.iter().map(|x| x.clean(cx)));
61 // Split up imports from all other items.
63 // This covers the case where somebody does an import which should pull in an item,
64 // but there's already an item with the same namespace and same name. Rust gives
65 // priority to the not-imported one, so we should, too.
66 let mut inserted = FxHashSet::default();
67 items.extend(self.items.iter().flat_map(|(item, renamed)| {
68 // First, lower everything other than imports.
69 if matches!(item.kind, hir::ItemKind::Use(..)) {
72 let v = clean_maybe_renamed_item(cx, item, *renamed);
74 if let Some(name) = item.name {
75 inserted.insert((item.type_(), name));
80 items.extend(self.items.iter().flat_map(|(item, renamed)| {
81 // Now we actually lower the imports, skipping everything else.
82 if !matches!(item.kind, hir::ItemKind::Use(..)) {
85 let mut v = clean_maybe_renamed_item(cx, item, *renamed);
86 v.drain_filter(|item| {
87 if let Some(name) = item.name {
88 // If an item with the same type and name already exists,
89 // it takes priority over the inlined stuff.
90 !inserted.insert((item.type_(), name))
98 // determine if we should display the inner contents or
99 // the outer `mod` item for the source code.
101 let span = Span::new({
102 let where_outer = self.where_outer(cx.tcx);
103 let sm = cx.sess().source_map();
104 let outer = sm.lookup_char_pos(where_outer.lo());
105 let inner = sm.lookup_char_pos(self.where_inner.lo());
106 if outer.file.start_pos == inner.file.start_pos {
110 // mod foo; (and a separate SourceFile for the contents)
115 Item::from_hir_id_and_parts(
118 ModuleItem(Module { items, span }),
124 impl<'tcx> Clean<'tcx, Attributes> for [ast::Attribute] {
125 fn clean(&self, _cx: &mut DocContext<'_>) -> Attributes {
126 Attributes::from_ast(self, None)
130 impl<'tcx> Clean<'tcx, Option<GenericBound>> for hir::GenericBound<'tcx> {
131 fn clean(&self, cx: &mut DocContext<'tcx>) -> Option<GenericBound> {
133 hir::GenericBound::Outlives(lt) => GenericBound::Outlives(lt.clean(cx)),
134 hir::GenericBound::LangItemTrait(lang_item, span, _, generic_args) => {
135 let def_id = cx.tcx.require_lang_item(lang_item, Some(span));
137 let trait_ref = ty::TraitRef::identity(cx.tcx, def_id).skip_binder();
139 let generic_args = generic_args.clean(cx);
140 let GenericArgs::AngleBracketed { bindings, .. } = generic_args
142 bug!("clean: parenthesized `GenericBound::LangItemTrait`");
145 let trait_ = clean_trait_ref_with_bindings(cx, trait_ref, &bindings);
146 GenericBound::TraitBound(
147 PolyTrait { trait_, generic_params: vec![] },
148 hir::TraitBoundModifier::None,
151 hir::GenericBound::Trait(ref t, modifier) => {
152 // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
153 if modifier == hir::TraitBoundModifier::MaybeConst
154 && cx.tcx.lang_items().destruct_trait()
155 == Some(t.trait_ref.trait_def_id().unwrap())
160 GenericBound::TraitBound(t.clean(cx), modifier)
166 fn clean_trait_ref_with_bindings<'tcx>(
167 cx: &mut DocContext<'tcx>,
168 trait_ref: ty::TraitRef<'tcx>,
169 bindings: &[TypeBinding],
171 let kind = cx.tcx.def_kind(trait_ref.def_id).into();
172 if !matches!(kind, ItemType::Trait | ItemType::TraitAlias) {
173 span_bug!(cx.tcx.def_span(trait_ref.def_id), "`TraitRef` had unexpected kind {:?}", kind);
175 inline::record_extern_fqn(cx, trait_ref.def_id, kind);
176 let path = external_path(cx, trait_ref.def_id, true, bindings.to_vec(), trait_ref.substs);
178 debug!("ty::TraitRef\n subst: {:?}\n", trait_ref.substs);
183 impl<'tcx> Clean<'tcx, Path> for ty::TraitRef<'tcx> {
184 fn clean(&self, cx: &mut DocContext<'tcx>) -> Path {
185 clean_trait_ref_with_bindings(cx, *self, &[])
189 fn clean_poly_trait_ref_with_bindings<'tcx>(
190 cx: &mut DocContext<'tcx>,
191 poly_trait_ref: ty::PolyTraitRef<'tcx>,
192 bindings: &[TypeBinding],
194 let poly_trait_ref = poly_trait_ref.lift_to_tcx(cx.tcx).unwrap();
196 // collect any late bound regions
197 let late_bound_regions: Vec<_> = cx
199 .collect_referenced_late_bound_regions(&poly_trait_ref)
201 .filter_map(|br| match br {
202 ty::BrNamed(_, name) if name != kw::UnderscoreLifetime => Some(GenericParamDef {
204 kind: GenericParamDefKind::Lifetime { outlives: vec![] },
210 let trait_ = clean_trait_ref_with_bindings(cx, poly_trait_ref.skip_binder(), bindings);
211 GenericBound::TraitBound(
212 PolyTrait { trait_, generic_params: late_bound_regions },
213 hir::TraitBoundModifier::None,
217 impl<'tcx> Clean<'tcx, GenericBound> for ty::PolyTraitRef<'tcx> {
218 fn clean(&self, cx: &mut DocContext<'tcx>) -> GenericBound {
219 clean_poly_trait_ref_with_bindings(cx, *self, &[])
223 impl<'tcx> Clean<'tcx, Lifetime> for hir::Lifetime {
224 fn clean(&self, cx: &mut DocContext<'tcx>) -> Lifetime {
225 let def = cx.tcx.named_region(self.hir_id);
227 rl::Region::EarlyBound(_, node_id)
228 | rl::Region::LateBound(_, _, node_id)
229 | rl::Region::Free(_, node_id),
232 if let Some(lt) = cx.substs.get(&node_id).and_then(|p| p.as_lt()).cloned() {
236 Lifetime(self.name.ident().name)
240 pub(crate) fn clean_const<'tcx>(constant: &hir::ConstArg, cx: &mut DocContext<'tcx>) -> Constant {
241 let def_id = cx.tcx.hir().body_owner_def_id(constant.value.body).to_def_id();
243 type_: clean_middle_ty(cx.tcx.type_of(def_id), cx, Some(def_id)),
244 kind: ConstantKind::Anonymous { body: constant.value.body },
248 pub(crate) fn clean_middle_const<'tcx>(
249 constant: ty::Const<'tcx>,
250 cx: &mut DocContext<'tcx>,
252 // FIXME: instead of storing the stringified expression, store `self` directly instead.
254 type_: clean_middle_ty(constant.ty(), cx, None),
255 kind: ConstantKind::TyConst { expr: constant.to_string() },
259 impl<'tcx> Clean<'tcx, Option<Lifetime>> for ty::Region<'tcx> {
260 fn clean(&self, _cx: &mut DocContext<'_>) -> Option<Lifetime> {
262 ty::ReStatic => Some(Lifetime::statik()),
263 ty::ReLateBound(_, ty::BoundRegion { kind: ty::BrNamed(_, name), .. }) => {
264 if name != kw::UnderscoreLifetime { Some(Lifetime(name)) } else { None }
266 ty::ReEarlyBound(ref data) => {
267 if data.name != kw::UnderscoreLifetime {
268 Some(Lifetime(data.name))
276 | ty::RePlaceholder(..)
279 debug!("cannot clean region {:?}", self);
286 impl<'tcx> Clean<'tcx, Option<WherePredicate>> for hir::WherePredicate<'tcx> {
287 fn clean(&self, cx: &mut DocContext<'tcx>) -> Option<WherePredicate> {
288 if !self.in_where_clause() {
292 hir::WherePredicate::BoundPredicate(ref wbp) => {
293 let bound_params = wbp
294 .bound_generic_params
297 // Higher-ranked params must be lifetimes.
298 // Higher-ranked lifetimes can't have bounds.
301 hir::GenericParam { kind: hir::GenericParamKind::Lifetime { .. }, .. }
303 Lifetime(param.name.ident().name)
306 WherePredicate::BoundPredicate {
307 ty: clean_ty(wbp.bounded_ty, cx),
308 bounds: wbp.bounds.iter().filter_map(|x| x.clean(cx)).collect(),
313 hir::WherePredicate::RegionPredicate(ref wrp) => WherePredicate::RegionPredicate {
314 lifetime: wrp.lifetime.clean(cx),
315 bounds: wrp.bounds.iter().filter_map(|x| x.clean(cx)).collect(),
318 hir::WherePredicate::EqPredicate(ref wrp) => WherePredicate::EqPredicate {
319 lhs: clean_ty(wrp.lhs_ty, cx),
320 rhs: clean_ty(wrp.rhs_ty, cx).into(),
326 impl<'tcx> Clean<'tcx, Option<WherePredicate>> for ty::Predicate<'tcx> {
327 fn clean(&self, cx: &mut DocContext<'tcx>) -> Option<WherePredicate> {
328 let bound_predicate = self.kind();
329 match bound_predicate.skip_binder() {
330 ty::PredicateKind::Trait(pred) => {
331 clean_poly_trait_predicate(bound_predicate.rebind(pred), cx)
333 ty::PredicateKind::RegionOutlives(pred) => clean_region_outlives_predicate(pred, cx),
334 ty::PredicateKind::TypeOutlives(pred) => clean_type_outlives_predicate(pred, cx),
335 ty::PredicateKind::Projection(pred) => Some(clean_projection_predicate(pred, cx)),
336 ty::PredicateKind::ConstEvaluatable(..) => None,
337 ty::PredicateKind::WellFormed(..) => None,
339 ty::PredicateKind::Subtype(..)
340 | ty::PredicateKind::Coerce(..)
341 | ty::PredicateKind::ObjectSafe(..)
342 | ty::PredicateKind::ClosureKind(..)
343 | ty::PredicateKind::ConstEquate(..)
344 | ty::PredicateKind::TypeWellFormedFromEnv(..) => panic!("not user writable"),
349 fn clean_poly_trait_predicate<'tcx>(
350 pred: ty::PolyTraitPredicate<'tcx>,
351 cx: &mut DocContext<'tcx>,
352 ) -> Option<WherePredicate> {
353 // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
354 if pred.skip_binder().constness == ty::BoundConstness::ConstIfConst
355 && Some(pred.skip_binder().def_id()) == cx.tcx.lang_items().destruct_trait()
360 let poly_trait_ref = pred.map_bound(|pred| pred.trait_ref);
361 Some(WherePredicate::BoundPredicate {
362 ty: clean_middle_ty(poly_trait_ref.skip_binder().self_ty(), cx, None),
363 bounds: vec![poly_trait_ref.clean(cx)],
364 bound_params: Vec::new(),
368 fn clean_region_outlives_predicate<'tcx>(
369 pred: ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>,
370 cx: &mut DocContext<'tcx>,
371 ) -> Option<WherePredicate> {
372 let ty::OutlivesPredicate(a, b) = pred;
374 if a.is_empty() && b.is_empty() {
378 Some(WherePredicate::RegionPredicate {
379 lifetime: a.clean(cx).expect("failed to clean lifetime"),
380 bounds: vec![GenericBound::Outlives(b.clean(cx).expect("failed to clean bounds"))],
384 fn clean_type_outlives_predicate<'tcx>(
385 pred: ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>,
386 cx: &mut DocContext<'tcx>,
387 ) -> Option<WherePredicate> {
388 let ty::OutlivesPredicate(ty, lt) = pred;
394 Some(WherePredicate::BoundPredicate {
395 ty: clean_middle_ty(ty, cx, None),
396 bounds: vec![GenericBound::Outlives(lt.clean(cx).expect("failed to clean lifetimes"))],
397 bound_params: Vec::new(),
401 fn clean_middle_term<'tcx>(term: ty::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
403 ty::Term::Ty(ty) => Term::Type(clean_middle_ty(ty, cx, None)),
404 ty::Term::Const(c) => Term::Constant(clean_middle_const(c, cx)),
408 fn clean_hir_term<'tcx>(term: &hir::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
410 hir::Term::Ty(ty) => Term::Type(clean_ty(ty, cx)),
411 hir::Term::Const(c) => {
412 let def_id = cx.tcx.hir().local_def_id(c.hir_id);
413 Term::Constant(clean_middle_const(ty::Const::from_anon_const(cx.tcx, def_id), cx))
418 fn clean_projection_predicate<'tcx>(
419 pred: ty::ProjectionPredicate<'tcx>,
420 cx: &mut DocContext<'tcx>,
421 ) -> WherePredicate {
422 let ty::ProjectionPredicate { projection_ty, term } = pred;
423 WherePredicate::EqPredicate {
424 lhs: clean_projection(projection_ty, cx, None),
425 rhs: clean_middle_term(term, cx),
429 fn clean_projection<'tcx>(
430 ty: ty::ProjectionTy<'tcx>,
431 cx: &mut DocContext<'tcx>,
432 def_id: Option<DefId>,
434 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
435 let trait_ = lifted.trait_ref(cx.tcx).clean(cx);
436 let self_type = clean_middle_ty(ty.self_ty(), cx, None);
437 let self_def_id = if let Some(def_id) = def_id {
438 cx.tcx.opt_parent(def_id).or(Some(def_id))
440 self_type.def_id(&cx.cache)
442 let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
444 assoc: Box::new(projection_to_path_segment(ty, cx)),
446 self_type: Box::new(self_type),
451 fn compute_should_show_cast(self_def_id: Option<DefId>, trait_: &Path, self_type: &Type) -> bool {
452 !trait_.segments.is_empty()
454 .zip(Some(trait_.def_id()))
455 .map_or(!self_type.is_self_type(), |(id, trait_)| id != trait_)
458 fn projection_to_path_segment<'tcx>(
459 ty: ty::ProjectionTy<'tcx>,
460 cx: &mut DocContext<'tcx>,
462 let item = cx.tcx.associated_item(ty.item_def_id);
463 let generics = cx.tcx.generics_of(ty.item_def_id);
466 args: GenericArgs::AngleBracketed {
467 args: substs_to_args(cx, &ty.substs[generics.parent_count..], false).into(),
468 bindings: Default::default(),
473 fn clean_generic_param_def<'tcx>(
474 def: &ty::GenericParamDef,
475 cx: &mut DocContext<'tcx>,
476 ) -> GenericParamDef {
477 let (name, kind) = match def.kind {
478 ty::GenericParamDefKind::Lifetime => {
479 (def.name, GenericParamDefKind::Lifetime { outlives: vec![] })
481 ty::GenericParamDefKind::Type { has_default, synthetic, .. } => {
482 let default = if has_default {
483 Some(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id)))
489 GenericParamDefKind::Type {
491 bounds: vec![], // These are filled in from the where-clauses.
492 default: default.map(Box::new),
497 ty::GenericParamDefKind::Const { has_default } => (
499 GenericParamDefKind::Const {
501 ty: Box::new(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id))),
502 default: match has_default {
503 true => Some(Box::new(cx.tcx.const_param_default(def.def_id).to_string())),
510 GenericParamDef { name, kind }
513 fn clean_generic_param<'tcx>(
514 cx: &mut DocContext<'tcx>,
515 generics: Option<&hir::Generics<'tcx>>,
516 param: &hir::GenericParam<'tcx>,
517 ) -> GenericParamDef {
518 let did = cx.tcx.hir().local_def_id(param.hir_id);
519 let (name, kind) = match param.kind {
520 hir::GenericParamKind::Lifetime { .. } => {
521 let outlives = if let Some(generics) = generics {
523 .outlives_for_param(did)
524 .filter(|bp| !bp.in_where_clause)
525 .flat_map(|bp| bp.bounds)
526 .map(|bound| match bound {
527 hir::GenericBound::Outlives(lt) => lt.clean(cx),
534 (param.name.ident().name, GenericParamDefKind::Lifetime { outlives })
536 hir::GenericParamKind::Type { ref default, synthetic } => {
537 let bounds = if let Some(generics) = generics {
539 .bounds_for_param(did)
540 .filter(|bp| bp.origin != PredicateOrigin::WhereClause)
541 .flat_map(|bp| bp.bounds)
542 .filter_map(|x| x.clean(cx))
548 param.name.ident().name,
549 GenericParamDefKind::Type {
550 did: did.to_def_id(),
552 default: default.map(|t| clean_ty(t, cx)).map(Box::new),
557 hir::GenericParamKind::Const { ty, default } => (
558 param.name.ident().name,
559 GenericParamDefKind::Const {
560 did: did.to_def_id(),
561 ty: Box::new(clean_ty(ty, cx)),
562 default: default.map(|ct| {
563 let def_id = cx.tcx.hir().local_def_id(ct.hir_id);
564 Box::new(ty::Const::from_anon_const(cx.tcx, def_id).to_string())
570 GenericParamDef { name, kind }
573 /// Synthetic type-parameters are inserted after normal ones.
574 /// In order for normal parameters to be able to refer to synthetic ones,
575 /// scans them first.
576 fn is_impl_trait(param: &hir::GenericParam<'_>) -> bool {
578 hir::GenericParamKind::Type { synthetic, .. } => synthetic,
583 /// This can happen for `async fn`, e.g. `async fn f<'_>(&'_ self)`.
585 /// See `lifetime_to_generic_param` in `rustc_ast_lowering` for more information.
586 fn is_elided_lifetime(param: &hir::GenericParam<'_>) -> bool {
587 matches!(param.kind, hir::GenericParamKind::Lifetime { kind: hir::LifetimeParamKind::Elided })
590 impl<'tcx> Clean<'tcx, Generics> for hir::Generics<'tcx> {
591 fn clean(&self, cx: &mut DocContext<'tcx>) -> Generics {
592 let impl_trait_params = self
595 .filter(|param| is_impl_trait(param))
597 let param = clean_generic_param(cx, Some(self), param);
599 GenericParamDefKind::Lifetime { .. } => unreachable!(),
600 GenericParamDefKind::Type { did, ref bounds, .. } => {
601 cx.impl_trait_bounds.insert(did.into(), bounds.clone());
603 GenericParamDefKind::Const { .. } => unreachable!(),
607 .collect::<Vec<_>>();
609 let mut params = Vec::with_capacity(self.params.len());
610 for p in self.params.iter().filter(|p| !is_impl_trait(p) && !is_elided_lifetime(p)) {
611 let p = clean_generic_param(cx, Some(self), p);
614 params.extend(impl_trait_params);
616 let mut generics = Generics {
618 where_predicates: self.predicates.iter().filter_map(|x| x.clean(cx)).collect(),
621 // Some duplicates are generated for ?Sized bounds between type params and where
622 // predicates. The point in here is to move the bounds definitions from type params
623 // to where predicates when such cases occur.
624 for where_pred in &mut generics.where_predicates {
626 WherePredicate::BoundPredicate {
627 ty: Generic(ref name), ref mut bounds, ..
629 if bounds.is_empty() {
630 for param in &mut generics.params {
632 GenericParamDefKind::Lifetime { .. } => {}
633 GenericParamDefKind::Type { bounds: ref mut ty_bounds, .. } => {
634 if ¶m.name == name {
635 mem::swap(bounds, ty_bounds);
639 GenericParamDefKind::Const { .. } => {}
651 fn clean_ty_generics<'tcx>(
652 cx: &mut DocContext<'tcx>,
654 preds: ty::GenericPredicates<'tcx>,
656 // Don't populate `cx.impl_trait_bounds` before `clean`ning `where` clauses,
657 // since `Clean for ty::Predicate` would consume them.
658 let mut impl_trait = BTreeMap::<ImplTraitParam, Vec<GenericBound>>::default();
660 // Bounds in the type_params and lifetimes fields are repeated in the
661 // predicates field (see rustc_typeck::collect::ty_generics), so remove
663 let stripped_params = gens
666 .filter_map(|param| match param.kind {
667 ty::GenericParamDefKind::Lifetime if param.name == kw::UnderscoreLifetime => None,
668 ty::GenericParamDefKind::Lifetime => Some(clean_generic_param_def(param, cx)),
669 ty::GenericParamDefKind::Type { synthetic, .. } => {
670 if param.name == kw::SelfUpper {
671 assert_eq!(param.index, 0);
675 impl_trait.insert(param.index.into(), vec![]);
678 Some(clean_generic_param_def(param, cx))
680 ty::GenericParamDefKind::Const { .. } => Some(clean_generic_param_def(param, cx)),
682 .collect::<Vec<GenericParamDef>>();
684 // param index -> [(DefId of trait, associated type name and generics, type)]
685 let mut impl_trait_proj = FxHashMap::<u32, Vec<(DefId, PathSegment, Ty<'_>)>>::default();
687 let where_predicates = preds
691 let mut projection = None;
692 let param_idx = (|| {
693 let bound_p = p.kind();
694 match bound_p.skip_binder() {
695 ty::PredicateKind::Trait(pred) => {
696 if let ty::Param(param) = pred.self_ty().kind() {
697 return Some(param.index);
700 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ty, _reg)) => {
701 if let ty::Param(param) = ty.kind() {
702 return Some(param.index);
705 ty::PredicateKind::Projection(p) => {
706 if let ty::Param(param) = p.projection_ty.self_ty().kind() {
707 projection = Some(bound_p.rebind(p));
708 return Some(param.index);
717 if let Some(param_idx) = param_idx {
718 if let Some(b) = impl_trait.get_mut(¶m_idx.into()) {
719 let p: WherePredicate = p.clean(cx)?;
726 .filter(|b| !b.is_sized_bound(cx)),
729 let proj = projection.map(|p| {
731 clean_projection(p.skip_binder().projection_ty, cx, None),
732 p.skip_binder().term,
735 if let Some(((_, trait_did, name), rhs)) = proj
737 .and_then(|(lhs, rhs): &(Type, _)| Some((lhs.projection()?, rhs)))
739 // FIXME(...): Remove this unwrap()
740 impl_trait_proj.entry(param_idx).or_default().push((
753 .collect::<Vec<_>>();
755 for (param, mut bounds) in impl_trait {
756 // Move trait bounds to the front.
757 bounds.sort_by_key(|b| !matches!(b, GenericBound::TraitBound(..)));
759 if let crate::core::ImplTraitParam::ParamIndex(idx) = param {
760 if let Some(proj) = impl_trait_proj.remove(&idx) {
761 for (trait_did, name, rhs) in proj {
762 let rhs = clean_middle_ty(rhs, cx, None);
763 simplify::merge_bounds(cx, &mut bounds, trait_did, name, &Term::Type(rhs));
770 cx.impl_trait_bounds.insert(param, bounds);
773 // Now that `cx.impl_trait_bounds` is populated, we can process
774 // remaining predicates which could contain `impl Trait`.
775 let mut where_predicates =
776 where_predicates.into_iter().flat_map(|p| p.clean(cx)).collect::<Vec<_>>();
778 // Type parameters have a Sized bound by default unless removed with
779 // ?Sized. Scan through the predicates and mark any type parameter with
780 // a Sized bound, removing the bounds as we find them.
782 // Note that associated types also have a sized bound by default, but we
783 // don't actually know the set of associated types right here so that's
784 // handled in cleaning associated types
785 let mut sized_params = FxHashSet::default();
786 where_predicates.retain(|pred| match *pred {
787 WherePredicate::BoundPredicate { ty: Generic(ref g), ref bounds, .. } => {
788 if bounds.iter().any(|b| b.is_sized_bound(cx)) {
789 sized_params.insert(*g);
798 // Run through the type parameters again and insert a ?Sized
799 // unbound for any we didn't find to be Sized.
800 for tp in &stripped_params {
801 if matches!(tp.kind, types::GenericParamDefKind::Type { .. })
802 && !sized_params.contains(&tp.name)
804 where_predicates.push(WherePredicate::BoundPredicate {
805 ty: Type::Generic(tp.name),
806 bounds: vec![GenericBound::maybe_sized(cx)],
807 bound_params: Vec::new(),
812 // It would be nice to collect all of the bounds on a type and recombine
813 // them if possible, to avoid e.g., `where T: Foo, T: Bar, T: Sized, T: 'a`
814 // and instead see `where T: Foo + Bar + Sized + 'a`
817 params: stripped_params,
818 where_predicates: simplify::where_clauses(cx, where_predicates),
822 fn clean_fn_or_proc_macro<'tcx>(
823 item: &hir::Item<'tcx>,
824 sig: &hir::FnSig<'tcx>,
825 generics: &hir::Generics<'tcx>,
826 body_id: hir::BodyId,
828 cx: &mut DocContext<'tcx>,
830 let attrs = cx.tcx.hir().attrs(item.hir_id());
831 let macro_kind = attrs.iter().find_map(|a| {
832 if a.has_name(sym::proc_macro) {
833 Some(MacroKind::Bang)
834 } else if a.has_name(sym::proc_macro_derive) {
835 Some(MacroKind::Derive)
836 } else if a.has_name(sym::proc_macro_attribute) {
837 Some(MacroKind::Attr)
844 if kind == MacroKind::Derive {
846 .lists(sym::proc_macro_derive)
847 .find_map(|mi| mi.ident())
848 .expect("proc-macro derives require a name")
852 let mut helpers = Vec::new();
853 for mi in attrs.lists(sym::proc_macro_derive) {
854 if !mi.has_name(sym::attributes) {
858 if let Some(list) = mi.meta_item_list() {
859 for inner_mi in list {
860 if let Some(ident) = inner_mi.ident() {
861 helpers.push(ident.name);
866 ProcMacroItem(ProcMacro { kind, helpers })
869 let mut func = clean_function(cx, sig, generics, body_id);
870 clean_fn_decl_legacy_const_generics(&mut func, attrs);
876 /// This is needed to make it more "readable" when documenting functions using
877 /// `rustc_legacy_const_generics`. More information in
878 /// <https://github.com/rust-lang/rust/issues/83167>.
879 fn clean_fn_decl_legacy_const_generics(func: &mut Function, attrs: &[ast::Attribute]) {
880 for meta_item_list in attrs
882 .filter(|a| a.has_name(sym::rustc_legacy_const_generics))
883 .filter_map(|a| a.meta_item_list())
885 for (pos, literal) in meta_item_list.iter().filter_map(|meta| meta.literal()).enumerate() {
887 ast::LitKind::Int(a, _) => {
888 let gen = func.generics.params.remove(0);
889 if let GenericParamDef { name, kind: GenericParamDefKind::Const { ty, .. } } =
895 .insert(a as _, Argument { name, type_: *ty, is_const: true });
897 panic!("unexpected non const in position {pos}");
900 _ => panic!("invalid arg index"),
906 fn clean_function<'tcx>(
907 cx: &mut DocContext<'tcx>,
908 sig: &hir::FnSig<'tcx>,
909 generics: &hir::Generics<'tcx>,
910 body_id: hir::BodyId,
912 let (generics, decl) = enter_impl_trait(cx, |cx| {
913 // NOTE: generics must be cleaned before args
914 let generics = generics.clean(cx);
915 let args = clean_args_from_types_and_body_id(cx, sig.decl.inputs, body_id);
916 let decl = clean_fn_decl_with_args(cx, sig.decl, args);
919 Box::new(Function { decl, generics })
922 fn clean_args_from_types_and_names<'tcx>(
923 cx: &mut DocContext<'tcx>,
924 types: &[hir::Ty<'tcx>],
932 let mut name = names.get(i).map_or(kw::Empty, |ident| ident.name);
934 name = kw::Underscore;
936 Argument { name, type_: clean_ty(ty, cx), is_const: false }
942 fn clean_args_from_types_and_body_id<'tcx>(
943 cx: &mut DocContext<'tcx>,
944 types: &[hir::Ty<'tcx>],
945 body_id: hir::BodyId,
947 let body = cx.tcx.hir().body(body_id);
953 .map(|(i, ty)| Argument {
954 name: name_from_pat(body.params[i].pat),
955 type_: clean_ty(ty, cx),
962 fn clean_fn_decl_with_args<'tcx>(
963 cx: &mut DocContext<'tcx>,
964 decl: &hir::FnDecl<'tcx>,
967 FnDecl { inputs: args, output: decl.output.clean(cx), c_variadic: decl.c_variadic }
970 fn clean_fn_decl_from_did_and_sig<'tcx>(
971 cx: &mut DocContext<'tcx>,
973 sig: ty::PolyFnSig<'tcx>,
975 let mut names = did.map_or(&[] as &[_], |did| cx.tcx.fn_arg_names(did)).iter();
977 // We assume all empty tuples are default return type. This theoretically can discard `-> ()`,
978 // but shouldn't change any code meaning.
979 let output = match clean_middle_ty(sig.skip_binder().output(), cx, None) {
980 Type::Tuple(inner) if inner.is_empty() => DefaultReturn,
986 c_variadic: sig.skip_binder().c_variadic,
993 type_: clean_middle_ty(*t, cx, None),
994 name: names.next().map_or(kw::Empty, |i| i.name),
1002 impl<'tcx> Clean<'tcx, FnRetTy> for hir::FnRetTy<'tcx> {
1003 fn clean(&self, cx: &mut DocContext<'tcx>) -> FnRetTy {
1005 Self::Return(typ) => Return(clean_ty(typ, cx)),
1006 Self::DefaultReturn(..) => DefaultReturn,
1011 impl<'tcx> Clean<'tcx, bool> for hir::IsAuto {
1012 fn clean(&self, _: &mut DocContext<'tcx>) -> bool {
1014 hir::IsAuto::Yes => true,
1015 hir::IsAuto::No => false,
1020 impl<'tcx> Clean<'tcx, Path> for hir::TraitRef<'tcx> {
1021 fn clean(&self, cx: &mut DocContext<'tcx>) -> Path {
1022 let path = self.path.clean(cx);
1023 register_res(cx, path.res);
1028 impl<'tcx> Clean<'tcx, PolyTrait> for hir::PolyTraitRef<'tcx> {
1029 fn clean(&self, cx: &mut DocContext<'tcx>) -> PolyTrait {
1031 trait_: self.trait_ref.clean(cx),
1032 generic_params: self
1033 .bound_generic_params
1035 .filter(|p| !is_elided_lifetime(p))
1036 .map(|x| clean_generic_param(cx, None, x))
1042 impl<'tcx> Clean<'tcx, Item> for hir::TraitItem<'tcx> {
1043 fn clean(&self, cx: &mut DocContext<'tcx>) -> Item {
1044 let local_did = self.def_id.to_def_id();
1045 cx.with_param_env(local_did, |cx| {
1046 let inner = match self.kind {
1047 hir::TraitItemKind::Const(ty, Some(default)) => AssocConstItem(
1049 ConstantKind::Local { def_id: local_did, body: default },
1051 hir::TraitItemKind::Const(ty, None) => TyAssocConstItem(clean_ty(ty, cx)),
1052 hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
1053 let m = clean_function(cx, sig, self.generics, body);
1056 hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Required(names)) => {
1057 let (generics, decl) = enter_impl_trait(cx, |cx| {
1058 // NOTE: generics must be cleaned before args
1059 let generics = self.generics.clean(cx);
1060 let args = clean_args_from_types_and_names(cx, sig.decl.inputs, names);
1061 let decl = clean_fn_decl_with_args(cx, sig.decl, args);
1064 TyMethodItem(Box::new(Function { decl, generics }))
1066 hir::TraitItemKind::Type(bounds, Some(default)) => {
1067 let generics = enter_impl_trait(cx, |cx| self.generics.clean(cx));
1068 let bounds = bounds.iter().filter_map(|x| x.clean(cx)).collect();
1069 let item_type = clean_middle_ty(hir_ty_to_ty(cx.tcx, default), cx, None);
1072 type_: clean_ty(default, cx),
1074 item_type: Some(item_type),
1079 hir::TraitItemKind::Type(bounds, None) => {
1080 let generics = enter_impl_trait(cx, |cx| self.generics.clean(cx));
1081 let bounds = bounds.iter().filter_map(|x| x.clean(cx)).collect();
1082 TyAssocTypeItem(Box::new(generics), bounds)
1085 let what_rustc_thinks =
1086 Item::from_def_id_and_parts(local_did, Some(self.ident.name), inner, cx);
1087 // Trait items always inherit the trait's visibility -- we don't want to show `pub`.
1088 Item { visibility: Inherited, ..what_rustc_thinks }
1093 impl<'tcx> Clean<'tcx, Item> for hir::ImplItem<'tcx> {
1094 fn clean(&self, cx: &mut DocContext<'tcx>) -> Item {
1095 let local_did = self.def_id.to_def_id();
1096 cx.with_param_env(local_did, |cx| {
1097 let inner = match self.kind {
1098 hir::ImplItemKind::Const(ty, expr) => {
1099 let default = ConstantKind::Local { def_id: local_did, body: expr };
1100 AssocConstItem(clean_ty(ty, cx), default)
1102 hir::ImplItemKind::Fn(ref sig, body) => {
1103 let m = clean_function(cx, sig, self.generics, body);
1104 let defaultness = cx.tcx.associated_item(self.def_id).defaultness;
1105 MethodItem(m, Some(defaultness))
1107 hir::ImplItemKind::TyAlias(hir_ty) => {
1108 let type_ = clean_ty(hir_ty, cx);
1109 let generics = self.generics.clean(cx);
1110 let item_type = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1112 Box::new(Typedef { type_, generics, item_type: Some(item_type) }),
1118 let mut what_rustc_thinks =
1119 Item::from_def_id_and_parts(local_did, Some(self.ident.name), inner, cx);
1121 let impl_ref = cx.tcx.impl_trait_ref(cx.tcx.local_parent(self.def_id));
1123 // Trait impl items always inherit the impl's visibility --
1124 // we don't want to show `pub`.
1125 if impl_ref.is_some() {
1126 what_rustc_thinks.visibility = Inherited;
1134 impl<'tcx> Clean<'tcx, Item> for ty::AssocItem {
1135 fn clean(&self, cx: &mut DocContext<'tcx>) -> Item {
1137 let kind = match self.kind {
1138 ty::AssocKind::Const => {
1139 let ty = clean_middle_ty(tcx.type_of(self.def_id), cx, Some(self.def_id));
1141 let provided = match self.container {
1142 ty::ImplContainer(_) => true,
1143 ty::TraitContainer(_) => self.defaultness.has_value(),
1146 AssocConstItem(ty, ConstantKind::Extern { def_id: self.def_id })
1148 TyAssocConstItem(ty)
1151 ty::AssocKind::Fn => {
1152 let generics = clean_ty_generics(
1154 tcx.generics_of(self.def_id),
1155 tcx.explicit_predicates_of(self.def_id),
1157 let sig = tcx.fn_sig(self.def_id);
1158 let mut decl = clean_fn_decl_from_did_and_sig(cx, Some(self.def_id), sig);
1160 if self.fn_has_self_parameter {
1161 let self_ty = match self.container {
1162 ty::ImplContainer(def_id) => tcx.type_of(def_id),
1163 ty::TraitContainer(_) => tcx.types.self_param,
1165 let self_arg_ty = sig.input(0).skip_binder();
1166 if self_arg_ty == self_ty {
1167 decl.inputs.values[0].type_ = Generic(kw::SelfUpper);
1168 } else if let ty::Ref(_, ty, _) = *self_arg_ty.kind() {
1170 match decl.inputs.values[0].type_ {
1171 BorrowedRef { ref mut type_, .. } => {
1172 **type_ = Generic(kw::SelfUpper)
1174 _ => unreachable!(),
1180 let provided = match self.container {
1181 ty::ImplContainer(_) => true,
1182 ty::TraitContainer(_) => self.defaultness.has_value(),
1185 let defaultness = match self.container {
1186 ty::ImplContainer(_) => Some(self.defaultness),
1187 ty::TraitContainer(_) => None,
1189 MethodItem(Box::new(Function { generics, decl }), defaultness)
1191 TyMethodItem(Box::new(Function { generics, decl }))
1194 ty::AssocKind::Type => {
1195 let my_name = self.name;
1197 fn param_eq_arg(param: &GenericParamDef, arg: &GenericArg) -> bool {
1198 match (¶m.kind, arg) {
1199 (GenericParamDefKind::Type { .. }, GenericArg::Type(Type::Generic(ty)))
1200 if *ty == param.name =>
1205 GenericParamDefKind::Lifetime { .. },
1206 GenericArg::Lifetime(Lifetime(lt)),
1207 ) if *lt == param.name => true,
1208 (GenericParamDefKind::Const { .. }, GenericArg::Const(c)) => {
1210 ConstantKind::TyConst { expr } => expr == param.name.as_str(),
1218 if let ty::TraitContainer(_) = self.container {
1219 let bounds = tcx.explicit_item_bounds(self.def_id);
1220 let predicates = ty::GenericPredicates { parent: None, predicates: bounds };
1222 clean_ty_generics(cx, tcx.generics_of(self.def_id), predicates);
1223 // Filter out the bounds that are (likely?) directly attached to the associated type,
1224 // as opposed to being located in the where clause.
1225 let mut bounds = generics
1227 .drain_filter(|pred| match *pred {
1228 WherePredicate::BoundPredicate {
1229 ty: QPath { ref assoc, ref self_type, ref trait_, .. },
1232 if assoc.name != my_name {
1235 if trait_.def_id() != self.container.id() {
1239 Generic(ref s) if *s == kw::SelfUpper => {}
1243 GenericArgs::AngleBracketed { args, bindings } => {
1244 if !bindings.is_empty()
1249 .any(|(param, arg)| !param_eq_arg(param, arg))
1254 GenericArgs::Parenthesized { .. } => {
1255 // The only time this happens is if we're inside the rustdoc for Fn(),
1256 // which only has one associated type, which is not a GAT, so whatever.
1264 if let WherePredicate::BoundPredicate { bounds, .. } = pred {
1270 .collect::<Vec<_>>();
1271 // Our Sized/?Sized bound didn't get handled when creating the generics
1272 // because we didn't actually get our whole set of bounds until just now
1273 // (some of them may have come from the trait). If we do have a sized
1274 // bound, we remove it, and if we don't then we add the `?Sized` bound
1276 match bounds.iter().position(|b| b.is_sized_bound(cx)) {
1280 None => bounds.push(GenericBound::maybe_sized(cx)),
1283 if self.defaultness.has_value() {
1286 type_: clean_middle_ty(
1287 tcx.type_of(self.def_id),
1292 // FIXME: should we obtain the Type from HIR and pass it on here?
1298 TyAssocTypeItem(Box::new(generics), bounds)
1301 // FIXME: when could this happen? Associated items in inherent impls?
1304 type_: clean_middle_ty(tcx.type_of(self.def_id), cx, Some(self.def_id)),
1305 generics: Generics { params: Vec::new(), where_predicates: Vec::new() },
1314 let mut what_rustc_thinks =
1315 Item::from_def_id_and_parts(self.def_id, Some(self.name), kind, cx);
1317 let impl_ref = tcx.impl_trait_ref(tcx.parent(self.def_id));
1319 // Trait impl items always inherit the impl's visibility --
1320 // we don't want to show `pub`.
1321 if impl_ref.is_some() {
1322 what_rustc_thinks.visibility = Visibility::Inherited;
1329 fn clean_qpath<'tcx>(hir_ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1330 let hir::Ty { hir_id: _, span, ref kind } = *hir_ty;
1331 let hir::TyKind::Path(qpath) = kind else { unreachable!() };
1334 hir::QPath::Resolved(None, path) => {
1335 if let Res::Def(DefKind::TyParam, did) = path.res {
1336 if let Some(new_ty) = cx.substs.get(&did).and_then(|p| p.as_ty()).cloned() {
1339 if let Some(bounds) = cx.impl_trait_bounds.remove(&did.into()) {
1340 return ImplTrait(bounds);
1344 if let Some(expanded) = maybe_expand_private_type_alias(cx, path) {
1347 let path = path.clean(cx);
1348 resolve_type(cx, path)
1351 hir::QPath::Resolved(Some(qself), p) => {
1352 // Try to normalize `<X as Y>::T` to a type
1353 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1354 if let Some(normalized_value) = normalize(cx, ty) {
1355 return clean_middle_ty(normalized_value, cx, None);
1358 let trait_segments = &p.segments[..p.segments.len() - 1];
1359 let trait_def = cx.tcx.associated_item(p.res.def_id()).container.id();
1360 let trait_ = self::Path {
1361 res: Res::Def(DefKind::Trait, trait_def),
1362 segments: trait_segments.iter().map(|x| x.clean(cx)).collect(),
1364 register_res(cx, trait_.res);
1365 let self_def_id = DefId::local(qself.hir_id.owner.local_def_index);
1366 let self_type = clean_ty(qself, cx);
1367 let should_show_cast = compute_should_show_cast(Some(self_def_id), &trait_, &self_type);
1369 assoc: Box::new(p.segments.last().expect("segments were empty").clean(cx)),
1371 self_type: Box::new(self_type),
1375 hir::QPath::TypeRelative(qself, segment) => {
1376 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1377 let res = match ty.kind() {
1378 ty::Projection(proj) => Res::Def(DefKind::Trait, proj.trait_ref(cx.tcx).def_id),
1379 // Rustdoc handles `ty::Error`s by turning them into `Type::Infer`s.
1380 ty::Error(_) => return Type::Infer,
1381 _ => bug!("clean: expected associated type, found `{:?}`", ty),
1383 let trait_ = hir::Path { span, res, segments: &[] }.clean(cx);
1384 register_res(cx, trait_.res);
1385 let self_def_id = res.opt_def_id();
1386 let self_type = clean_ty(qself, cx);
1387 let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
1389 assoc: Box::new(segment.clean(cx)),
1391 self_type: Box::new(self_type),
1395 hir::QPath::LangItem(..) => bug!("clean: requiring documentation of lang item"),
1399 fn maybe_expand_private_type_alias<'tcx>(
1400 cx: &mut DocContext<'tcx>,
1401 path: &hir::Path<'tcx>,
1403 let Res::Def(DefKind::TyAlias, def_id) = path.res else { return None };
1404 // Substitute private type aliases
1405 let def_id = def_id.as_local()?;
1406 let alias = if !cx.cache.access_levels.is_exported(def_id.to_def_id()) {
1407 &cx.tcx.hir().expect_item(def_id).kind
1411 let hir::ItemKind::TyAlias(ty, generics) = alias else { return None };
1413 let provided_params = &path.segments.last().expect("segments were empty");
1414 let mut substs = FxHashMap::default();
1415 let generic_args = provided_params.args();
1417 let mut indices: hir::GenericParamCount = Default::default();
1418 for param in generics.params.iter() {
1420 hir::GenericParamKind::Lifetime { .. } => {
1422 let lifetime = generic_args.args.iter().find_map(|arg| match arg {
1423 hir::GenericArg::Lifetime(lt) => {
1424 if indices.lifetimes == j {
1432 if let Some(lt) = lifetime.cloned() {
1433 let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1434 let cleaned = if !lt.is_elided() { lt.clean(cx) } else { Lifetime::elided() };
1435 substs.insert(lt_def_id.to_def_id(), SubstParam::Lifetime(cleaned));
1437 indices.lifetimes += 1;
1439 hir::GenericParamKind::Type { ref default, .. } => {
1440 let ty_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1442 let type_ = generic_args.args.iter().find_map(|arg| match arg {
1443 hir::GenericArg::Type(ty) => {
1444 if indices.types == j {
1452 if let Some(ty) = type_ {
1453 substs.insert(ty_param_def_id.to_def_id(), SubstParam::Type(clean_ty(ty, cx)));
1454 } else if let Some(default) = *default {
1456 ty_param_def_id.to_def_id(),
1457 SubstParam::Type(clean_ty(default, cx)),
1462 hir::GenericParamKind::Const { .. } => {
1463 let const_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1465 let const_ = generic_args.args.iter().find_map(|arg| match arg {
1466 hir::GenericArg::Const(ct) => {
1467 if indices.consts == j {
1475 if let Some(ct) = const_ {
1477 const_param_def_id.to_def_id(),
1478 SubstParam::Constant(clean_const(ct, cx)),
1481 // FIXME(const_generics_defaults)
1482 indices.consts += 1;
1487 Some(cx.enter_alias(substs, |cx| clean_ty(ty, cx)))
1490 pub(crate) fn clean_ty<'tcx>(ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1494 TyKind::Never => Primitive(PrimitiveType::Never),
1495 TyKind::Ptr(ref m) => RawPointer(m.mutbl, Box::new(clean_ty(m.ty, cx))),
1496 TyKind::Rptr(ref l, ref m) => {
1497 // There are two times a `Fresh` lifetime can be created:
1498 // 1. For `&'_ x`, written by the user. This corresponds to `lower_lifetime` in `rustc_ast_lowering`.
1499 // 2. For `&x` as a parameter to an `async fn`. This corresponds to `elided_ref_lifetime in `rustc_ast_lowering`.
1500 // See #59286 for more information.
1501 // Ideally we would only hide the `'_` for case 2., but I don't know a way to distinguish it.
1502 // Turning `fn f(&'_ self)` into `fn f(&self)` isn't the worst thing in the world, though;
1503 // there's no case where it could cause the function to fail to compile.
1505 l.is_elided() || matches!(l.name, LifetimeName::Param(_, ParamName::Fresh));
1506 let lifetime = if elided { None } else { Some(l.clean(cx)) };
1507 BorrowedRef { lifetime, mutability: m.mutbl, type_: Box::new(clean_ty(m.ty, cx)) }
1509 TyKind::Slice(ty) => Slice(Box::new(clean_ty(ty, cx))),
1510 TyKind::Array(ty, ref length) => {
1511 let length = match length {
1512 hir::ArrayLen::Infer(_, _) => "_".to_string(),
1513 hir::ArrayLen::Body(anon_const) => {
1514 let def_id = cx.tcx.hir().local_def_id(anon_const.hir_id);
1515 // NOTE(min_const_generics): We can't use `const_eval_poly` for constants
1516 // as we currently do not supply the parent generics to anonymous constants
1517 // but do allow `ConstKind::Param`.
1519 // `const_eval_poly` tries to to first substitute generic parameters which
1520 // results in an ICE while manually constructing the constant and using `eval`
1521 // does nothing for `ConstKind::Param`.
1522 let ct = ty::Const::from_anon_const(cx.tcx, def_id);
1523 let param_env = cx.tcx.param_env(def_id);
1524 print_const(cx, ct.eval(cx.tcx, param_env))
1528 Array(Box::new(clean_ty(ty, cx)), length)
1530 TyKind::Tup(tys) => Tuple(tys.iter().map(|ty| clean_ty(ty, cx)).collect()),
1531 TyKind::OpaqueDef(item_id, _) => {
1532 let item = cx.tcx.hir().item(item_id);
1533 if let hir::ItemKind::OpaqueTy(ref ty) = item.kind {
1534 ImplTrait(ty.bounds.iter().filter_map(|x| x.clean(cx)).collect())
1539 TyKind::Path(_) => clean_qpath(ty, cx),
1540 TyKind::TraitObject(bounds, ref lifetime, _) => {
1541 let bounds = bounds.iter().map(|bound| bound.clean(cx)).collect();
1542 let lifetime = if !lifetime.is_elided() { Some(lifetime.clean(cx)) } else { None };
1543 DynTrait(bounds, lifetime)
1545 TyKind::BareFn(barefn) => BareFunction(Box::new(barefn.clean(cx))),
1546 // Rustdoc handles `TyKind::Err`s by turning them into `Type::Infer`s.
1547 TyKind::Infer | TyKind::Err => Infer,
1548 TyKind::Typeof(..) => panic!("unimplemented type {:?}", ty.kind),
1552 /// Returns `None` if the type could not be normalized
1553 fn normalize<'tcx>(cx: &mut DocContext<'tcx>, ty: Ty<'_>) -> Option<Ty<'tcx>> {
1554 // HACK: low-churn fix for #79459 while we wait for a trait normalization fix
1555 if !cx.tcx.sess.opts.unstable_opts.normalize_docs {
1559 use crate::rustc_trait_selection::infer::TyCtxtInferExt;
1560 use crate::rustc_trait_selection::traits::query::normalize::AtExt;
1561 use rustc_middle::traits::ObligationCause;
1563 // Try to normalize `<X as Y>::T` to a type
1564 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
1565 let normalized = cx.tcx.infer_ctxt().enter(|infcx| {
1567 .at(&ObligationCause::dummy(), cx.param_env)
1569 .map(|resolved| infcx.resolve_vars_if_possible(resolved.value))
1572 Ok(normalized_value) => {
1573 debug!("normalized {:?} to {:?}", ty, normalized_value);
1574 Some(normalized_value)
1577 debug!("failed to normalize {:?}: {:?}", ty, err);
1583 pub(crate) fn clean_middle_ty<'tcx>(
1585 cx: &mut DocContext<'tcx>,
1586 def_id: Option<DefId>,
1588 trace!("cleaning type: {:?}", this);
1589 let ty = normalize(cx, this).unwrap_or(this);
1591 ty::Never => Primitive(PrimitiveType::Never),
1592 ty::Bool => Primitive(PrimitiveType::Bool),
1593 ty::Char => Primitive(PrimitiveType::Char),
1594 ty::Int(int_ty) => Primitive(int_ty.into()),
1595 ty::Uint(uint_ty) => Primitive(uint_ty.into()),
1596 ty::Float(float_ty) => Primitive(float_ty.into()),
1597 ty::Str => Primitive(PrimitiveType::Str),
1598 ty::Slice(ty) => Slice(Box::new(clean_middle_ty(ty, cx, None))),
1599 ty::Array(ty, n) => {
1600 let mut n = cx.tcx.lift(n).expect("array lift failed");
1601 n = n.eval(cx.tcx, ty::ParamEnv::reveal_all());
1602 let n = print_const(cx, n);
1603 Array(Box::new(clean_middle_ty(ty, cx, None)), n)
1605 ty::RawPtr(mt) => RawPointer(mt.mutbl, Box::new(clean_middle_ty(mt.ty, cx, None))),
1606 ty::Ref(r, ty, mutbl) => BorrowedRef {
1607 lifetime: r.clean(cx),
1609 type_: Box::new(clean_middle_ty(ty, cx, None)),
1611 ty::FnDef(..) | ty::FnPtr(_) => {
1612 let ty = cx.tcx.lift(this).expect("FnPtr lift failed");
1613 let sig = ty.fn_sig(cx.tcx);
1614 let decl = clean_fn_decl_from_did_and_sig(cx, None, sig);
1615 BareFunction(Box::new(BareFunctionDecl {
1616 unsafety: sig.unsafety(),
1617 generic_params: Vec::new(),
1622 ty::Adt(def, substs) => {
1623 let did = def.did();
1624 let kind = match def.adt_kind() {
1625 AdtKind::Struct => ItemType::Struct,
1626 AdtKind::Union => ItemType::Union,
1627 AdtKind::Enum => ItemType::Enum,
1629 inline::record_extern_fqn(cx, did, kind);
1630 let path = external_path(cx, did, false, vec![], substs);
1633 ty::Foreign(did) => {
1634 inline::record_extern_fqn(cx, did, ItemType::ForeignType);
1635 let path = external_path(cx, did, false, vec![], InternalSubsts::empty());
1638 ty::Dynamic(obj, ref reg) => {
1639 // HACK: pick the first `did` as the `did` of the trait object. Someone
1640 // might want to implement "native" support for marker-trait-only
1642 let mut dids = obj.principal_def_id().into_iter().chain(obj.auto_traits());
1645 .unwrap_or_else(|| panic!("found trait object `{:?}` with no traits?", this));
1646 let substs = match obj.principal() {
1647 Some(principal) => principal.skip_binder().substs,
1648 // marker traits have no substs.
1649 _ => cx.tcx.intern_substs(&[]),
1652 inline::record_extern_fqn(cx, did, ItemType::Trait);
1654 let lifetime = reg.clean(cx);
1655 let mut bounds = vec![];
1658 let empty = cx.tcx.intern_substs(&[]);
1659 let path = external_path(cx, did, false, vec![], empty);
1660 inline::record_extern_fqn(cx, did, ItemType::Trait);
1661 let bound = PolyTrait { trait_: path, generic_params: Vec::new() };
1665 let mut bindings = vec![];
1666 for pb in obj.projection_bounds() {
1667 bindings.push(TypeBinding {
1668 assoc: projection_to_path_segment(
1670 .lift_to_tcx(cx.tcx)
1672 // HACK(compiler-errors): Doesn't actually matter what self
1673 // type we put here, because we're only using the GAT's substs.
1674 .with_self_ty(cx.tcx, cx.tcx.types.self_param)
1678 kind: TypeBindingKind::Equality {
1679 term: clean_middle_term(pb.skip_binder().term, cx),
1684 let path = external_path(cx, did, false, bindings, substs);
1685 bounds.insert(0, PolyTrait { trait_: path, generic_params: Vec::new() });
1687 DynTrait(bounds, lifetime)
1689 ty::Tuple(t) => Tuple(t.iter().map(|t| clean_middle_ty(t, cx, None)).collect()),
1691 ty::Projection(ref data) => clean_projection(*data, cx, def_id),
1693 ty::Param(ref p) => {
1694 if let Some(bounds) = cx.impl_trait_bounds.remove(&p.index.into()) {
1701 ty::Opaque(def_id, substs) => {
1702 // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
1703 // by looking up the bounds associated with the def_id.
1704 let substs = cx.tcx.lift(substs).expect("Opaque lift failed");
1707 .explicit_item_bounds(def_id)
1709 .map(|(bound, _)| EarlyBinder(*bound).subst(cx.tcx, substs))
1710 .collect::<Vec<_>>();
1711 let mut regions = vec![];
1712 let mut has_sized = false;
1713 let mut bounds = bounds
1715 .filter_map(|bound| {
1716 let bound_predicate = bound.kind();
1717 let trait_ref = match bound_predicate.skip_binder() {
1718 ty::PredicateKind::Trait(tr) => bound_predicate.rebind(tr.trait_ref),
1719 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(_ty, reg)) => {
1720 if let Some(r) = reg.clean(cx) {
1721 regions.push(GenericBound::Outlives(r));
1728 if let Some(sized) = cx.tcx.lang_items().sized_trait() {
1729 if trait_ref.def_id() == sized {
1735 let bindings: Vec<_> = bounds
1737 .filter_map(|bound| {
1738 if let ty::PredicateKind::Projection(proj) = bound.kind().skip_binder()
1740 if proj.projection_ty.trait_ref(cx.tcx) == trait_ref.skip_binder() {
1742 assoc: projection_to_path_segment(proj.projection_ty, cx),
1743 kind: TypeBindingKind::Equality {
1744 term: clean_middle_term(proj.term, cx),
1756 Some(clean_poly_trait_ref_with_bindings(cx, trait_ref, &bindings))
1758 .collect::<Vec<_>>();
1759 bounds.extend(regions);
1760 if !has_sized && !bounds.is_empty() {
1761 bounds.insert(0, GenericBound::maybe_sized(cx));
1766 ty::Closure(..) => panic!("Closure"),
1767 ty::Generator(..) => panic!("Generator"),
1768 ty::Bound(..) => panic!("Bound"),
1769 ty::Placeholder(..) => panic!("Placeholder"),
1770 ty::GeneratorWitness(..) => panic!("GeneratorWitness"),
1771 ty::Infer(..) => panic!("Infer"),
1772 ty::Error(_) => panic!("Error"),
1776 pub(crate) fn clean_field<'tcx>(field: &hir::FieldDef<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1777 let def_id = cx.tcx.hir().local_def_id(field.hir_id).to_def_id();
1778 clean_field_with_def_id(def_id, field.ident.name, clean_ty(field.ty, cx), cx)
1781 pub(crate) fn clean_middle_field<'tcx>(field: &ty::FieldDef, cx: &mut DocContext<'tcx>) -> Item {
1782 clean_field_with_def_id(
1785 clean_middle_ty(cx.tcx.type_of(field.did), cx, Some(field.did)),
1790 pub(crate) fn clean_field_with_def_id(
1794 cx: &mut DocContext<'_>,
1796 let what_rustc_thinks =
1797 Item::from_def_id_and_parts(def_id, Some(name), StructFieldItem(ty), cx);
1798 if is_field_vis_inherited(cx.tcx, def_id) {
1799 // Variant fields inherit their enum's visibility.
1800 Item { visibility: Visibility::Inherited, ..what_rustc_thinks }
1806 fn is_field_vis_inherited(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1807 let parent = tcx.parent(def_id);
1808 match tcx.def_kind(parent) {
1809 DefKind::Struct | DefKind::Union => false,
1810 DefKind::Variant => true,
1811 parent_kind => panic!("unexpected parent kind: {:?}", parent_kind),
1815 pub(crate) fn clean_visibility(vis: ty::Visibility) -> Visibility {
1817 ty::Visibility::Public => Visibility::Public,
1818 // NOTE: this is not quite right: `ty` uses `Invisible` to mean 'private',
1819 // while rustdoc really does mean inherited. That means that for enum variants, such as
1820 // `pub enum E { V }`, `V` will be marked as `Public` by `ty`, but as `Inherited` by rustdoc.
1821 // Various parts of clean override `tcx.visibility` explicitly to make sure this distinction is captured.
1822 ty::Visibility::Invisible => Visibility::Inherited,
1823 ty::Visibility::Restricted(module) => Visibility::Restricted(module),
1827 pub(crate) fn clean_variant_def<'tcx>(variant: &ty::VariantDef, cx: &mut DocContext<'tcx>) -> Item {
1828 let kind = match variant.ctor_kind {
1829 CtorKind::Const => Variant::CLike,
1830 CtorKind::Fn => Variant::Tuple(
1831 variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1833 CtorKind::Fictive => Variant::Struct(VariantStruct {
1834 struct_type: CtorKind::Fictive,
1835 fields: variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1838 let what_rustc_thinks =
1839 Item::from_def_id_and_parts(variant.def_id, Some(variant.name), VariantItem(kind), cx);
1840 // don't show `pub` for variants, which always inherit visibility
1841 Item { visibility: Inherited, ..what_rustc_thinks }
1844 fn clean_variant_data<'tcx>(
1845 variant: &hir::VariantData<'tcx>,
1846 cx: &mut DocContext<'tcx>,
1849 hir::VariantData::Struct(..) => Variant::Struct(VariantStruct {
1850 struct_type: CtorKind::from_hir(variant),
1851 fields: variant.fields().iter().map(|x| clean_field(x, cx)).collect(),
1853 hir::VariantData::Tuple(..) => {
1854 Variant::Tuple(variant.fields().iter().map(|x| clean_field(x, cx)).collect())
1856 hir::VariantData::Unit(..) => Variant::CLike,
1860 impl<'tcx> Clean<'tcx, Path> for hir::Path<'tcx> {
1861 fn clean(&self, cx: &mut DocContext<'tcx>) -> Path {
1862 Path { res: self.res, segments: self.segments.iter().map(|x| x.clean(cx)).collect() }
1866 impl<'tcx> Clean<'tcx, GenericArgs> for hir::GenericArgs<'tcx> {
1867 fn clean(&self, cx: &mut DocContext<'tcx>) -> GenericArgs {
1868 if self.parenthesized {
1869 let output = clean_ty(self.bindings[0].ty(), cx);
1871 if output != Type::Tuple(Vec::new()) { Some(Box::new(output)) } else { None };
1872 let inputs = self.inputs().iter().map(|x| clean_ty(x, cx)).collect::<Vec<_>>().into();
1873 GenericArgs::Parenthesized { inputs, output }
1878 .map(|arg| match arg {
1879 hir::GenericArg::Lifetime(lt) if !lt.is_elided() => {
1880 GenericArg::Lifetime(lt.clean(cx))
1882 hir::GenericArg::Lifetime(_) => GenericArg::Lifetime(Lifetime::elided()),
1883 hir::GenericArg::Type(ty) => GenericArg::Type(clean_ty(ty, cx)),
1884 hir::GenericArg::Const(ct) => GenericArg::Const(Box::new(clean_const(ct, cx))),
1885 hir::GenericArg::Infer(_inf) => GenericArg::Infer,
1887 .collect::<Vec<_>>()
1889 let bindings = self.bindings.iter().map(|x| x.clean(cx)).collect::<Vec<_>>().into();
1890 GenericArgs::AngleBracketed { args, bindings }
1895 impl<'tcx> Clean<'tcx, PathSegment> for hir::PathSegment<'tcx> {
1896 fn clean(&self, cx: &mut DocContext<'tcx>) -> PathSegment {
1897 PathSegment { name: self.ident.name, args: self.args().clean(cx) }
1901 impl<'tcx> Clean<'tcx, BareFunctionDecl> for hir::BareFnTy<'tcx> {
1902 fn clean(&self, cx: &mut DocContext<'tcx>) -> BareFunctionDecl {
1903 let (generic_params, decl) = enter_impl_trait(cx, |cx| {
1904 // NOTE: generics must be cleaned before args
1905 let generic_params = self
1908 .filter(|p| !is_elided_lifetime(p))
1909 .map(|x| clean_generic_param(cx, None, x))
1911 let args = clean_args_from_types_and_names(cx, self.decl.inputs, self.param_names);
1912 let decl = clean_fn_decl_with_args(cx, self.decl, args);
1913 (generic_params, decl)
1915 BareFunctionDecl { unsafety: self.unsafety, abi: self.abi, decl, generic_params }
1919 fn clean_maybe_renamed_item<'tcx>(
1920 cx: &mut DocContext<'tcx>,
1921 item: &hir::Item<'tcx>,
1922 renamed: Option<Symbol>,
1926 let def_id = item.def_id.to_def_id();
1927 let mut name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
1928 cx.with_param_env(def_id, |cx| {
1929 let kind = match item.kind {
1930 ItemKind::Static(ty, mutability, body_id) => {
1931 StaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: Some(body_id) })
1933 ItemKind::Const(ty, body_id) => ConstantItem(Constant {
1934 type_: clean_ty(ty, cx),
1935 kind: ConstantKind::Local { body: body_id, def_id },
1937 ItemKind::OpaqueTy(ref ty) => OpaqueTyItem(OpaqueTy {
1938 bounds: ty.bounds.iter().filter_map(|x| x.clean(cx)).collect(),
1939 generics: ty.generics.clean(cx),
1941 ItemKind::TyAlias(hir_ty, generics) => {
1942 let rustdoc_ty = clean_ty(hir_ty, cx);
1943 let ty = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1944 TypedefItem(Box::new(Typedef {
1946 generics: generics.clean(cx),
1947 item_type: Some(ty),
1950 ItemKind::Enum(ref def, generics) => EnumItem(Enum {
1951 variants: def.variants.iter().map(|v| v.clean(cx)).collect(),
1952 generics: generics.clean(cx),
1954 ItemKind::TraitAlias(generics, bounds) => TraitAliasItem(TraitAlias {
1955 generics: generics.clean(cx),
1956 bounds: bounds.iter().filter_map(|x| x.clean(cx)).collect(),
1958 ItemKind::Union(ref variant_data, generics) => UnionItem(Union {
1959 generics: generics.clean(cx),
1960 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1962 ItemKind::Struct(ref variant_data, generics) => StructItem(Struct {
1963 struct_type: CtorKind::from_hir(variant_data),
1964 generics: generics.clean(cx),
1965 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1967 ItemKind::Impl(impl_) => return clean_impl(impl_, item.hir_id(), cx),
1968 // proc macros can have a name set by attributes
1969 ItemKind::Fn(ref sig, generics, body_id) => {
1970 clean_fn_or_proc_macro(item, sig, generics, body_id, &mut name, cx)
1972 ItemKind::Macro(ref macro_def, _) => {
1973 let ty_vis = clean_visibility(cx.tcx.visibility(def_id));
1975 source: display_macro_source(cx, name, macro_def, def_id, ty_vis),
1978 ItemKind::Trait(_, _, generics, bounds, item_ids) => {
1980 item_ids.iter().map(|ti| cx.tcx.hir().trait_item(ti.id).clean(cx)).collect();
1985 generics: generics.clean(cx),
1986 bounds: bounds.iter().filter_map(|x| x.clean(cx)).collect(),
1989 ItemKind::ExternCrate(orig_name) => {
1990 return clean_extern_crate(item, name, orig_name, cx);
1992 ItemKind::Use(path, kind) => {
1993 return clean_use_statement(item, name, path, kind, cx);
1995 _ => unreachable!("not yet converted"),
1998 vec![Item::from_def_id_and_parts(def_id, Some(name), kind, cx)]
2002 impl<'tcx> Clean<'tcx, Item> for hir::Variant<'tcx> {
2003 fn clean(&self, cx: &mut DocContext<'tcx>) -> Item {
2004 let kind = VariantItem(clean_variant_data(&self.data, cx));
2005 let what_rustc_thinks =
2006 Item::from_hir_id_and_parts(self.id, Some(self.ident.name), kind, cx);
2007 // don't show `pub` for variants, which are always public
2008 Item { visibility: Inherited, ..what_rustc_thinks }
2012 fn clean_impl<'tcx>(
2013 impl_: &hir::Impl<'tcx>,
2015 cx: &mut DocContext<'tcx>,
2018 let mut ret = Vec::new();
2019 let trait_ = impl_.of_trait.as_ref().map(|t| t.clean(cx));
2021 impl_.items.iter().map(|ii| tcx.hir().impl_item(ii.id).clean(cx)).collect::<Vec<_>>();
2022 let def_id = tcx.hir().local_def_id(hir_id);
2024 // If this impl block is an implementation of the Deref trait, then we
2025 // need to try inlining the target's inherent impl blocks as well.
2026 if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
2027 build_deref_target_impls(cx, &items, &mut ret);
2030 let for_ = clean_ty(impl_.self_ty, cx);
2031 let type_alias = for_.def_id(&cx.cache).and_then(|did| match tcx.def_kind(did) {
2032 DefKind::TyAlias => Some(clean_middle_ty(tcx.type_of(did), cx, Some(did))),
2035 let mut make_item = |trait_: Option<Path>, for_: Type, items: Vec<Item>| {
2036 let kind = ImplItem(Box::new(Impl {
2037 unsafety: impl_.unsafety,
2038 generics: impl_.generics.clean(cx),
2042 polarity: tcx.impl_polarity(def_id),
2043 kind: if utils::has_doc_flag(tcx, def_id.to_def_id(), sym::fake_variadic) {
2044 ImplKind::FakeVaradic
2049 Item::from_hir_id_and_parts(hir_id, None, kind, cx)
2051 if let Some(type_alias) = type_alias {
2052 ret.push(make_item(trait_.clone(), type_alias, items.clone()));
2054 ret.push(make_item(trait_, for_, items));
2058 fn clean_extern_crate<'tcx>(
2059 krate: &hir::Item<'tcx>,
2061 orig_name: Option<Symbol>,
2062 cx: &mut DocContext<'tcx>,
2064 // this is the ID of the `extern crate` statement
2065 let cnum = cx.tcx.extern_mod_stmt_cnum(krate.def_id).unwrap_or(LOCAL_CRATE);
2066 // this is the ID of the crate itself
2067 let crate_def_id = cnum.as_def_id();
2068 let attrs = cx.tcx.hir().attrs(krate.hir_id());
2069 let ty_vis = cx.tcx.visibility(krate.def_id);
2070 let please_inline = ty_vis.is_public()
2071 && attrs.iter().any(|a| {
2072 a.has_name(sym::doc)
2073 && match a.meta_item_list() {
2074 Some(l) => attr::list_contains_name(&l, sym::inline),
2080 let mut visited = FxHashSet::default();
2082 let res = Res::Def(DefKind::Mod, crate_def_id);
2084 if let Some(items) = inline::try_inline(
2086 cx.tcx.parent_module(krate.hir_id()).to_def_id(),
2087 Some(krate.def_id.to_def_id()),
2097 // FIXME: using `from_def_id_and_kind` breaks `rustdoc/masked` for some reason
2100 attrs: Box::new(attrs.clean(cx)),
2101 item_id: crate_def_id.into(),
2102 visibility: clean_visibility(ty_vis),
2103 kind: Box::new(ExternCrateItem { src: orig_name }),
2104 cfg: attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
2108 fn clean_use_statement<'tcx>(
2109 import: &hir::Item<'tcx>,
2111 path: &hir::Path<'tcx>,
2113 cx: &mut DocContext<'tcx>,
2115 // We need this comparison because some imports (for std types for example)
2116 // are "inserted" as well but directly by the compiler and they should not be
2117 // taken into account.
2118 if import.span.ctxt().outer_expn_data().kind == ExpnKind::AstPass(AstPass::StdImports) {
2122 let visibility = cx.tcx.visibility(import.def_id);
2123 let attrs = cx.tcx.hir().attrs(import.hir_id());
2124 let inline_attr = attrs.lists(sym::doc).get_word_attr(sym::inline);
2125 let pub_underscore = visibility.is_public() && name == kw::Underscore;
2126 let current_mod = cx.tcx.parent_module_from_def_id(import.def_id);
2128 // The parent of the module in which this import resides. This
2129 // is the same as `current_mod` if that's already the top
2131 let parent_mod = cx.tcx.parent_module_from_def_id(current_mod);
2133 // This checks if the import can be seen from a higher level module.
2134 // In other words, it checks if the visibility is the equivalent of
2135 // `pub(super)` or higher. If the current module is the top level
2136 // module, there isn't really a parent module, which makes the results
2137 // meaningless. In this case, we make sure the answer is `false`.
2138 let is_visible_from_parent_mod = visibility.is_accessible_from(parent_mod.to_def_id(), cx.tcx)
2139 && !current_mod.is_top_level_module();
2142 if let Some(ref inline) = inline_attr {
2143 rustc_errors::struct_span_err!(
2147 "anonymous imports cannot be inlined"
2149 .span_label(import.span, "anonymous import")
2154 // We consider inlining the documentation of `pub use` statements, but we
2155 // forcefully don't inline if this is not public or if the
2156 // #[doc(no_inline)] attribute is present.
2157 // Don't inline doc(hidden) imports so they can be stripped at a later stage.
2158 let mut denied = cx.output_format.is_json()
2159 || !(visibility.is_public()
2160 || (cx.render_options.document_private && is_visible_from_parent_mod))
2162 || attrs.iter().any(|a| {
2163 a.has_name(sym::doc)
2164 && match a.meta_item_list() {
2166 attr::list_contains_name(&l, sym::no_inline)
2167 || attr::list_contains_name(&l, sym::hidden)
2173 // Also check whether imports were asked to be inlined, in case we're trying to re-export a
2174 // crate in Rust 2018+
2175 let path = path.clean(cx);
2176 let inner = if kind == hir::UseKind::Glob {
2178 let mut visited = FxHashSet::default();
2179 if let Some(items) = inline::try_inline_glob(cx, path.res, &mut visited) {
2183 Import::new_glob(resolve_use_source(cx, path), true)
2185 if inline_attr.is_none() {
2186 if let Res::Def(DefKind::Mod, did) = path.res {
2187 if !did.is_local() && did.is_crate_root() {
2188 // if we're `pub use`ing an extern crate root, don't inline it unless we
2189 // were specifically asked for it
2195 let mut visited = FxHashSet::default();
2196 let import_def_id = import.def_id.to_def_id();
2198 if let Some(mut items) = inline::try_inline(
2200 cx.tcx.parent_module(import.hir_id()).to_def_id(),
2201 Some(import_def_id),
2207 items.push(Item::from_def_id_and_parts(
2210 ImportItem(Import::new_simple(name, resolve_use_source(cx, path), false)),
2216 Import::new_simple(name, resolve_use_source(cx, path), true)
2219 vec![Item::from_def_id_and_parts(import.def_id.to_def_id(), None, ImportItem(inner), cx)]
2222 fn clean_maybe_renamed_foreign_item<'tcx>(
2223 cx: &mut DocContext<'tcx>,
2224 item: &hir::ForeignItem<'tcx>,
2225 renamed: Option<Symbol>,
2227 let def_id = item.def_id.to_def_id();
2228 cx.with_param_env(def_id, |cx| {
2229 let kind = match item.kind {
2230 hir::ForeignItemKind::Fn(decl, names, generics) => {
2231 let (generics, decl) = enter_impl_trait(cx, |cx| {
2232 // NOTE: generics must be cleaned before args
2233 let generics = generics.clean(cx);
2234 let args = clean_args_from_types_and_names(cx, decl.inputs, names);
2235 let decl = clean_fn_decl_with_args(cx, decl, args);
2238 ForeignFunctionItem(Box::new(Function { decl, generics }))
2240 hir::ForeignItemKind::Static(ty, mutability) => {
2241 ForeignStaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: None })
2243 hir::ForeignItemKind::Type => ForeignTypeItem,
2246 Item::from_hir_id_and_parts(
2248 Some(renamed.unwrap_or(item.ident.name)),
2255 impl<'tcx> Clean<'tcx, TypeBinding> for hir::TypeBinding<'tcx> {
2256 fn clean(&self, cx: &mut DocContext<'tcx>) -> TypeBinding {
2258 assoc: PathSegment { name: self.ident.name, args: self.gen_args.clean(cx) },
2259 kind: self.kind.clean(cx),
2264 impl<'tcx> Clean<'tcx, TypeBindingKind> for hir::TypeBindingKind<'tcx> {
2265 fn clean(&self, cx: &mut DocContext<'tcx>) -> TypeBindingKind {
2267 hir::TypeBindingKind::Equality { ref term } => {
2268 TypeBindingKind::Equality { term: clean_hir_term(term, cx) }
2270 hir::TypeBindingKind::Constraint { bounds } => TypeBindingKind::Constraint {
2271 bounds: bounds.iter().filter_map(|b| b.clean(cx)).collect(),