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;
37 use thin_vec::ThinVec;
39 use crate::core::{self, DocContext, ImplTraitParam};
40 use crate::formats::item_type::ItemType;
41 use crate::visit_ast::Module as DocModule;
45 pub(crate) use self::types::*;
46 pub(crate) use self::utils::{get_auto_trait_and_blanket_impls, krate, register_res};
48 pub(crate) fn clean_doc_module<'tcx>(doc: &DocModule<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
49 let mut items: Vec<Item> = vec![];
50 let mut inserted = FxHashSet::default();
51 items.extend(doc.foreigns.iter().map(|(item, renamed)| {
52 let item = clean_maybe_renamed_foreign_item(cx, item, *renamed);
53 if let Some(name) = item.name {
54 inserted.insert((item.type_(), name));
58 items.extend(doc.mods.iter().map(|x| {
59 inserted.insert((ItemType::Module, x.name));
60 clean_doc_module(x, cx)
63 // Split up imports from all other items.
65 // This covers the case where somebody does an import which should pull in an item,
66 // but there's already an item with the same namespace and same name. Rust gives
67 // priority to the not-imported one, so we should, too.
68 items.extend(doc.items.iter().flat_map(|(item, renamed)| {
69 // First, lower everything other than imports.
70 if matches!(item.kind, hir::ItemKind::Use(_, hir::UseKind::Glob)) {
73 let v = clean_maybe_renamed_item(cx, item, *renamed);
75 if let Some(name) = item.name {
76 inserted.insert((item.type_(), name));
81 items.extend(doc.items.iter().flat_map(|(item, renamed)| {
82 // Now we actually lower the imports, skipping everything else.
83 if let hir::ItemKind::Use(path, hir::UseKind::Glob) = item.kind {
84 let name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
85 clean_use_statement(item, name, path, hir::UseKind::Glob, cx, &mut inserted)
87 // skip everything else
92 // determine if we should display the inner contents or
93 // the outer `mod` item for the source code.
95 let span = Span::new({
96 let where_outer = doc.where_outer(cx.tcx);
97 let sm = cx.sess().source_map();
98 let outer = sm.lookup_char_pos(where_outer.lo());
99 let inner = sm.lookup_char_pos(doc.where_inner.lo());
100 if outer.file.start_pos == inner.file.start_pos {
104 // mod foo; (and a separate SourceFile for the contents)
109 Item::from_hir_id_and_parts(doc.id, Some(doc.name), ModuleItem(Module { items, span }), cx)
112 fn clean_generic_bound<'tcx>(
113 bound: &hir::GenericBound<'tcx>,
114 cx: &mut DocContext<'tcx>,
115 ) -> Option<GenericBound> {
117 hir::GenericBound::Outlives(lt) => GenericBound::Outlives(clean_lifetime(lt, cx)),
118 hir::GenericBound::LangItemTrait(lang_item, span, _, generic_args) => {
119 let def_id = cx.tcx.require_lang_item(lang_item, Some(span));
121 let trait_ref = ty::TraitRef::identity(cx.tcx, def_id).skip_binder();
123 let generic_args = clean_generic_args(generic_args, cx);
124 let GenericArgs::AngleBracketed { bindings, .. } = generic_args
126 bug!("clean: parenthesized `GenericBound::LangItemTrait`");
129 let trait_ = clean_trait_ref_with_bindings(cx, trait_ref, bindings);
130 GenericBound::TraitBound(
131 PolyTrait { trait_, generic_params: vec![] },
132 hir::TraitBoundModifier::None,
135 hir::GenericBound::Trait(ref t, modifier) => {
136 // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
137 if modifier == hir::TraitBoundModifier::MaybeConst
138 && cx.tcx.lang_items().destruct_trait() == Some(t.trait_ref.trait_def_id().unwrap())
143 GenericBound::TraitBound(clean_poly_trait_ref(t, cx), modifier)
148 pub(crate) fn clean_trait_ref_with_bindings<'tcx>(
149 cx: &mut DocContext<'tcx>,
150 trait_ref: ty::TraitRef<'tcx>,
151 bindings: ThinVec<TypeBinding>,
153 let kind = cx.tcx.def_kind(trait_ref.def_id).into();
154 if !matches!(kind, ItemType::Trait | ItemType::TraitAlias) {
155 span_bug!(cx.tcx.def_span(trait_ref.def_id), "`TraitRef` had unexpected kind {:?}", kind);
157 inline::record_extern_fqn(cx, trait_ref.def_id, kind);
158 let path = external_path(cx, trait_ref.def_id, true, bindings, trait_ref.substs);
160 debug!("ty::TraitRef\n subst: {:?}\n", trait_ref.substs);
165 fn clean_poly_trait_ref_with_bindings<'tcx>(
166 cx: &mut DocContext<'tcx>,
167 poly_trait_ref: ty::PolyTraitRef<'tcx>,
168 bindings: ThinVec<TypeBinding>,
170 let poly_trait_ref = poly_trait_ref.lift_to_tcx(cx.tcx).unwrap();
172 // collect any late bound regions
173 let late_bound_regions: Vec<_> = cx
175 .collect_referenced_late_bound_regions(&poly_trait_ref)
177 .filter_map(|br| match br {
178 ty::BrNamed(_, name) if name != kw::UnderscoreLifetime => Some(GenericParamDef {
180 kind: GenericParamDefKind::Lifetime { outlives: vec![] },
186 let trait_ = clean_trait_ref_with_bindings(cx, poly_trait_ref.skip_binder(), bindings);
187 GenericBound::TraitBound(
188 PolyTrait { trait_, generic_params: late_bound_regions },
189 hir::TraitBoundModifier::None,
193 fn clean_lifetime<'tcx>(lifetime: hir::Lifetime, cx: &mut DocContext<'tcx>) -> Lifetime {
194 let def = cx.tcx.named_region(lifetime.hir_id);
196 rl::Region::EarlyBound(node_id)
197 | rl::Region::LateBound(_, _, node_id)
198 | rl::Region::Free(_, node_id),
201 if let Some(lt) = cx.substs.get(&node_id).and_then(|p| p.as_lt()).cloned() {
205 Lifetime(lifetime.name.ident().name)
208 pub(crate) fn clean_const<'tcx>(constant: &hir::ConstArg, cx: &mut DocContext<'tcx>) -> Constant {
209 let def_id = cx.tcx.hir().body_owner_def_id(constant.value.body).to_def_id();
211 type_: clean_middle_ty(cx.tcx.type_of(def_id), cx, Some(def_id)),
212 kind: ConstantKind::Anonymous { body: constant.value.body },
216 pub(crate) fn clean_middle_const<'tcx>(
217 constant: ty::Const<'tcx>,
218 cx: &mut DocContext<'tcx>,
220 // FIXME: instead of storing the stringified expression, store `self` directly instead.
222 type_: clean_middle_ty(constant.ty(), cx, None),
223 kind: ConstantKind::TyConst { expr: constant.to_string() },
227 pub(crate) fn clean_middle_region<'tcx>(region: ty::Region<'tcx>) -> Option<Lifetime> {
229 ty::ReStatic => Some(Lifetime::statik()),
230 ty::ReLateBound(_, ty::BoundRegion { kind: ty::BrNamed(_, name), .. }) => {
231 if name != kw::UnderscoreLifetime { Some(Lifetime(name)) } else { None }
233 ty::ReEarlyBound(ref data) => {
234 if data.name != kw::UnderscoreLifetime {
235 Some(Lifetime(data.name))
243 | ty::RePlaceholder(..)
246 debug!("cannot clean region {:?}", region);
252 fn clean_where_predicate<'tcx>(
253 predicate: &hir::WherePredicate<'tcx>,
254 cx: &mut DocContext<'tcx>,
255 ) -> Option<WherePredicate> {
256 if !predicate.in_where_clause() {
259 Some(match *predicate {
260 hir::WherePredicate::BoundPredicate(ref wbp) => {
261 let bound_params = wbp
262 .bound_generic_params
265 // Higher-ranked params must be lifetimes.
266 // Higher-ranked lifetimes can't have bounds.
269 hir::GenericParam { kind: hir::GenericParamKind::Lifetime { .. }, .. }
271 Lifetime(param.name.ident().name)
274 WherePredicate::BoundPredicate {
275 ty: clean_ty(wbp.bounded_ty, cx),
276 bounds: wbp.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
281 hir::WherePredicate::RegionPredicate(ref wrp) => WherePredicate::RegionPredicate {
282 lifetime: clean_lifetime(wrp.lifetime, cx),
283 bounds: wrp.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
286 hir::WherePredicate::EqPredicate(ref wrp) => WherePredicate::EqPredicate {
287 lhs: clean_ty(wrp.lhs_ty, cx),
288 rhs: clean_ty(wrp.rhs_ty, cx).into(),
293 pub(crate) fn clean_predicate<'tcx>(
294 predicate: ty::Predicate<'tcx>,
295 cx: &mut DocContext<'tcx>,
296 ) -> Option<WherePredicate> {
297 let bound_predicate = predicate.kind();
298 match bound_predicate.skip_binder() {
299 ty::PredicateKind::Trait(pred) => {
300 clean_poly_trait_predicate(bound_predicate.rebind(pred), cx)
302 ty::PredicateKind::RegionOutlives(pred) => clean_region_outlives_predicate(pred),
303 ty::PredicateKind::TypeOutlives(pred) => clean_type_outlives_predicate(pred, cx),
304 ty::PredicateKind::Projection(pred) => Some(clean_projection_predicate(pred, cx)),
305 ty::PredicateKind::ConstEvaluatable(..) => None,
306 ty::PredicateKind::WellFormed(..) => None,
308 ty::PredicateKind::Subtype(..)
309 | ty::PredicateKind::Coerce(..)
310 | ty::PredicateKind::ObjectSafe(..)
311 | ty::PredicateKind::ClosureKind(..)
312 | ty::PredicateKind::ConstEquate(..)
313 | ty::PredicateKind::TypeWellFormedFromEnv(..) => panic!("not user writable"),
317 fn clean_poly_trait_predicate<'tcx>(
318 pred: ty::PolyTraitPredicate<'tcx>,
319 cx: &mut DocContext<'tcx>,
320 ) -> Option<WherePredicate> {
321 // `T: ~const Destruct` is hidden because `T: Destruct` is a no-op.
322 if pred.skip_binder().constness == ty::BoundConstness::ConstIfConst
323 && Some(pred.skip_binder().def_id()) == cx.tcx.lang_items().destruct_trait()
328 let poly_trait_ref = pred.map_bound(|pred| pred.trait_ref);
329 Some(WherePredicate::BoundPredicate {
330 ty: clean_middle_ty(poly_trait_ref.skip_binder().self_ty(), cx, None),
331 bounds: vec![clean_poly_trait_ref_with_bindings(cx, poly_trait_ref, ThinVec::new())],
332 bound_params: Vec::new(),
336 fn clean_region_outlives_predicate<'tcx>(
337 pred: ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>,
338 ) -> Option<WherePredicate> {
339 let ty::OutlivesPredicate(a, b) = pred;
341 if a.is_empty() && b.is_empty() {
345 Some(WherePredicate::RegionPredicate {
346 lifetime: clean_middle_region(a).expect("failed to clean lifetime"),
347 bounds: vec![GenericBound::Outlives(
348 clean_middle_region(b).expect("failed to clean bounds"),
353 fn clean_type_outlives_predicate<'tcx>(
354 pred: ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>,
355 cx: &mut DocContext<'tcx>,
356 ) -> Option<WherePredicate> {
357 let ty::OutlivesPredicate(ty, lt) = pred;
363 Some(WherePredicate::BoundPredicate {
364 ty: clean_middle_ty(ty, cx, None),
365 bounds: vec![GenericBound::Outlives(
366 clean_middle_region(lt).expect("failed to clean lifetimes"),
368 bound_params: Vec::new(),
372 fn clean_middle_term<'tcx>(term: ty::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
373 match term.unpack() {
374 ty::TermKind::Ty(ty) => Term::Type(clean_middle_ty(ty, cx, None)),
375 ty::TermKind::Const(c) => Term::Constant(clean_middle_const(c, cx)),
379 fn clean_hir_term<'tcx>(term: &hir::Term<'tcx>, cx: &mut DocContext<'tcx>) -> Term {
381 hir::Term::Ty(ty) => Term::Type(clean_ty(ty, cx)),
382 hir::Term::Const(c) => {
383 let def_id = cx.tcx.hir().local_def_id(c.hir_id);
384 Term::Constant(clean_middle_const(ty::Const::from_anon_const(cx.tcx, def_id), cx))
389 fn clean_projection_predicate<'tcx>(
390 pred: ty::ProjectionPredicate<'tcx>,
391 cx: &mut DocContext<'tcx>,
392 ) -> WherePredicate {
393 let ty::ProjectionPredicate { projection_ty, term } = pred;
394 WherePredicate::EqPredicate {
395 lhs: clean_projection(projection_ty, cx, None),
396 rhs: clean_middle_term(term, cx),
400 fn clean_projection<'tcx>(
401 ty: ty::ProjectionTy<'tcx>,
402 cx: &mut DocContext<'tcx>,
403 def_id: Option<DefId>,
405 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
406 let trait_ = clean_trait_ref_with_bindings(cx, lifted.trait_ref(cx.tcx), ThinVec::new());
407 let self_type = clean_middle_ty(ty.self_ty(), cx, None);
408 let self_def_id = if let Some(def_id) = def_id {
409 cx.tcx.opt_parent(def_id).or(Some(def_id))
411 self_type.def_id(&cx.cache)
413 let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
414 Type::QPath(Box::new(QPathData {
415 assoc: projection_to_path_segment(ty, cx),
422 fn compute_should_show_cast(self_def_id: Option<DefId>, trait_: &Path, self_type: &Type) -> bool {
423 !trait_.segments.is_empty()
425 .zip(Some(trait_.def_id()))
426 .map_or(!self_type.is_self_type(), |(id, trait_)| id != trait_)
429 fn projection_to_path_segment<'tcx>(
430 ty: ty::ProjectionTy<'tcx>,
431 cx: &mut DocContext<'tcx>,
433 let item = cx.tcx.associated_item(ty.item_def_id);
434 let generics = cx.tcx.generics_of(ty.item_def_id);
437 args: GenericArgs::AngleBracketed {
438 args: substs_to_args(cx, &ty.substs[generics.parent_count..], false).into(),
439 bindings: Default::default(),
444 fn clean_generic_param_def<'tcx>(
445 def: &ty::GenericParamDef,
446 cx: &mut DocContext<'tcx>,
447 ) -> GenericParamDef {
448 let (name, kind) = match def.kind {
449 ty::GenericParamDefKind::Lifetime => {
450 (def.name, GenericParamDefKind::Lifetime { outlives: vec![] })
452 ty::GenericParamDefKind::Type { has_default, synthetic, .. } => {
453 let default = if has_default {
454 Some(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id)))
460 GenericParamDefKind::Type {
462 bounds: vec![], // These are filled in from the where-clauses.
463 default: default.map(Box::new),
468 ty::GenericParamDefKind::Const { has_default } => (
470 GenericParamDefKind::Const {
472 ty: Box::new(clean_middle_ty(cx.tcx.type_of(def.def_id), cx, Some(def.def_id))),
473 default: match has_default {
474 true => Some(Box::new(cx.tcx.const_param_default(def.def_id).to_string())),
481 GenericParamDef { name, kind }
484 fn clean_generic_param<'tcx>(
485 cx: &mut DocContext<'tcx>,
486 generics: Option<&hir::Generics<'tcx>>,
487 param: &hir::GenericParam<'tcx>,
488 ) -> GenericParamDef {
489 let did = cx.tcx.hir().local_def_id(param.hir_id);
490 let (name, kind) = match param.kind {
491 hir::GenericParamKind::Lifetime { .. } => {
492 let outlives = if let Some(generics) = generics {
494 .outlives_for_param(did)
495 .filter(|bp| !bp.in_where_clause)
496 .flat_map(|bp| bp.bounds)
497 .map(|bound| match bound {
498 hir::GenericBound::Outlives(lt) => clean_lifetime(*lt, cx),
505 (param.name.ident().name, GenericParamDefKind::Lifetime { outlives })
507 hir::GenericParamKind::Type { ref default, synthetic } => {
508 let bounds = if let Some(generics) = generics {
510 .bounds_for_param(did)
511 .filter(|bp| bp.origin != PredicateOrigin::WhereClause)
512 .flat_map(|bp| bp.bounds)
513 .filter_map(|x| clean_generic_bound(x, cx))
519 param.name.ident().name,
520 GenericParamDefKind::Type {
521 did: did.to_def_id(),
523 default: default.map(|t| clean_ty(t, cx)).map(Box::new),
528 hir::GenericParamKind::Const { ty, default } => (
529 param.name.ident().name,
530 GenericParamDefKind::Const {
531 did: did.to_def_id(),
532 ty: Box::new(clean_ty(ty, cx)),
533 default: default.map(|ct| {
534 let def_id = cx.tcx.hir().local_def_id(ct.hir_id);
535 Box::new(ty::Const::from_anon_const(cx.tcx, def_id).to_string())
541 GenericParamDef { name, kind }
544 /// Synthetic type-parameters are inserted after normal ones.
545 /// In order for normal parameters to be able to refer to synthetic ones,
546 /// scans them first.
547 fn is_impl_trait(param: &hir::GenericParam<'_>) -> bool {
549 hir::GenericParamKind::Type { synthetic, .. } => synthetic,
554 /// This can happen for `async fn`, e.g. `async fn f<'_>(&'_ self)`.
556 /// See `lifetime_to_generic_param` in `rustc_ast_lowering` for more information.
557 fn is_elided_lifetime(param: &hir::GenericParam<'_>) -> bool {
558 matches!(param.kind, hir::GenericParamKind::Lifetime { kind: hir::LifetimeParamKind::Elided })
561 pub(crate) fn clean_generics<'tcx>(
562 gens: &hir::Generics<'tcx>,
563 cx: &mut DocContext<'tcx>,
565 let impl_trait_params = gens
568 .filter(|param| is_impl_trait(param))
570 let param = clean_generic_param(cx, Some(gens), param);
572 GenericParamDefKind::Lifetime { .. } => unreachable!(),
573 GenericParamDefKind::Type { did, ref bounds, .. } => {
574 cx.impl_trait_bounds.insert(did.into(), bounds.clone());
576 GenericParamDefKind::Const { .. } => unreachable!(),
580 .collect::<Vec<_>>();
582 let mut params = Vec::with_capacity(gens.params.len());
583 for p in gens.params.iter().filter(|p| !is_impl_trait(p) && !is_elided_lifetime(p)) {
584 let p = clean_generic_param(cx, Some(gens), p);
587 params.extend(impl_trait_params);
589 let mut generics = Generics {
591 where_predicates: gens
594 .filter_map(|x| clean_where_predicate(x, cx))
598 // Some duplicates are generated for ?Sized bounds between type params and where
599 // predicates. The point in here is to move the bounds definitions from type params
600 // to where predicates when such cases occur.
601 for where_pred in &mut generics.where_predicates {
603 WherePredicate::BoundPredicate { ty: Generic(ref name), ref mut bounds, .. } => {
604 if bounds.is_empty() {
605 for param in &mut generics.params {
607 GenericParamDefKind::Lifetime { .. } => {}
608 GenericParamDefKind::Type { bounds: ref mut ty_bounds, .. } => {
609 if ¶m.name == name {
610 mem::swap(bounds, ty_bounds);
614 GenericParamDefKind::Const { .. } => {}
625 fn clean_ty_generics<'tcx>(
626 cx: &mut DocContext<'tcx>,
628 preds: ty::GenericPredicates<'tcx>,
630 // Don't populate `cx.impl_trait_bounds` before `clean`ning `where` clauses,
631 // since `Clean for ty::Predicate` would consume them.
632 let mut impl_trait = BTreeMap::<ImplTraitParam, Vec<GenericBound>>::default();
634 // Bounds in the type_params and lifetimes fields are repeated in the
635 // predicates field (see rustc_typeck::collect::ty_generics), so remove
637 let stripped_params = gens
640 .filter_map(|param| match param.kind {
641 ty::GenericParamDefKind::Lifetime if param.name == kw::UnderscoreLifetime => None,
642 ty::GenericParamDefKind::Lifetime => Some(clean_generic_param_def(param, cx)),
643 ty::GenericParamDefKind::Type { synthetic, .. } => {
644 if param.name == kw::SelfUpper {
645 assert_eq!(param.index, 0);
649 impl_trait.insert(param.index.into(), vec![]);
652 Some(clean_generic_param_def(param, cx))
654 ty::GenericParamDefKind::Const { .. } => Some(clean_generic_param_def(param, cx)),
656 .collect::<Vec<GenericParamDef>>();
658 // param index -> [(DefId of trait, associated type name and generics, type)]
659 let mut impl_trait_proj = FxHashMap::<u32, Vec<(DefId, PathSegment, Ty<'_>)>>::default();
661 let where_predicates = preds
665 let mut projection = None;
666 let param_idx = (|| {
667 let bound_p = p.kind();
668 match bound_p.skip_binder() {
669 ty::PredicateKind::Trait(pred) => {
670 if let ty::Param(param) = pred.self_ty().kind() {
671 return Some(param.index);
674 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ty, _reg)) => {
675 if let ty::Param(param) = ty.kind() {
676 return Some(param.index);
679 ty::PredicateKind::Projection(p) => {
680 if let ty::Param(param) = p.projection_ty.self_ty().kind() {
681 projection = Some(bound_p.rebind(p));
682 return Some(param.index);
691 if let Some(param_idx) = param_idx {
692 if let Some(b) = impl_trait.get_mut(¶m_idx.into()) {
693 let p: WherePredicate = clean_predicate(*p, cx)?;
700 .filter(|b| !b.is_sized_bound(cx)),
703 let proj = projection.map(|p| {
705 clean_projection(p.skip_binder().projection_ty, cx, None),
706 p.skip_binder().term,
709 if let Some(((_, trait_did, name), rhs)) = proj
711 .and_then(|(lhs, rhs): &(Type, _)| Some((lhs.projection()?, rhs)))
713 // FIXME(...): Remove this unwrap()
714 impl_trait_proj.entry(param_idx).or_default().push((
727 .collect::<Vec<_>>();
729 for (param, mut bounds) in impl_trait {
730 // Move trait bounds to the front.
731 bounds.sort_by_key(|b| !matches!(b, GenericBound::TraitBound(..)));
733 if let crate::core::ImplTraitParam::ParamIndex(idx) = param {
734 if let Some(proj) = impl_trait_proj.remove(&idx) {
735 for (trait_did, name, rhs) in proj {
736 let rhs = clean_middle_ty(rhs, cx, None);
737 simplify::merge_bounds(cx, &mut bounds, trait_did, name, &Term::Type(rhs));
744 cx.impl_trait_bounds.insert(param, bounds);
747 // Now that `cx.impl_trait_bounds` is populated, we can process
748 // remaining predicates which could contain `impl Trait`.
749 let mut where_predicates =
750 where_predicates.into_iter().flat_map(|p| clean_predicate(*p, cx)).collect::<Vec<_>>();
752 // Type parameters have a Sized bound by default unless removed with
753 // ?Sized. Scan through the predicates and mark any type parameter with
754 // a Sized bound, removing the bounds as we find them.
756 // Note that associated types also have a sized bound by default, but we
757 // don't actually know the set of associated types right here so that's
758 // handled in cleaning associated types
759 let mut sized_params = FxHashSet::default();
760 where_predicates.retain(|pred| match *pred {
761 WherePredicate::BoundPredicate { ty: Generic(ref g), ref bounds, .. } => {
762 if bounds.iter().any(|b| b.is_sized_bound(cx)) {
763 sized_params.insert(*g);
772 // Run through the type parameters again and insert a ?Sized
773 // unbound for any we didn't find to be Sized.
774 for tp in &stripped_params {
775 if matches!(tp.kind, types::GenericParamDefKind::Type { .. })
776 && !sized_params.contains(&tp.name)
778 where_predicates.push(WherePredicate::BoundPredicate {
779 ty: Type::Generic(tp.name),
780 bounds: vec![GenericBound::maybe_sized(cx)],
781 bound_params: Vec::new(),
786 // It would be nice to collect all of the bounds on a type and recombine
787 // them if possible, to avoid e.g., `where T: Foo, T: Bar, T: Sized, T: 'a`
788 // and instead see `where T: Foo + Bar + Sized + 'a`
791 params: stripped_params,
792 where_predicates: simplify::where_clauses(cx, where_predicates),
796 fn clean_fn_or_proc_macro<'tcx>(
797 item: &hir::Item<'tcx>,
798 sig: &hir::FnSig<'tcx>,
799 generics: &hir::Generics<'tcx>,
800 body_id: hir::BodyId,
802 cx: &mut DocContext<'tcx>,
804 let attrs = cx.tcx.hir().attrs(item.hir_id());
805 let macro_kind = attrs.iter().find_map(|a| {
806 if a.has_name(sym::proc_macro) {
807 Some(MacroKind::Bang)
808 } else if a.has_name(sym::proc_macro_derive) {
809 Some(MacroKind::Derive)
810 } else if a.has_name(sym::proc_macro_attribute) {
811 Some(MacroKind::Attr)
818 if kind == MacroKind::Derive {
820 .lists(sym::proc_macro_derive)
821 .find_map(|mi| mi.ident())
822 .expect("proc-macro derives require a name")
826 let mut helpers = Vec::new();
827 for mi in attrs.lists(sym::proc_macro_derive) {
828 if !mi.has_name(sym::attributes) {
832 if let Some(list) = mi.meta_item_list() {
833 for inner_mi in list {
834 if let Some(ident) = inner_mi.ident() {
835 helpers.push(ident.name);
840 ProcMacroItem(ProcMacro { kind, helpers })
843 let mut func = clean_function(cx, sig, generics, body_id);
844 clean_fn_decl_legacy_const_generics(&mut func, attrs);
850 /// This is needed to make it more "readable" when documenting functions using
851 /// `rustc_legacy_const_generics`. More information in
852 /// <https://github.com/rust-lang/rust/issues/83167>.
853 fn clean_fn_decl_legacy_const_generics(func: &mut Function, attrs: &[ast::Attribute]) {
854 for meta_item_list in attrs
856 .filter(|a| a.has_name(sym::rustc_legacy_const_generics))
857 .filter_map(|a| a.meta_item_list())
859 for (pos, literal) in meta_item_list.iter().filter_map(|meta| meta.literal()).enumerate() {
861 ast::LitKind::Int(a, _) => {
862 let gen = func.generics.params.remove(0);
863 if let GenericParamDef { name, kind: GenericParamDefKind::Const { ty, .. } } =
869 .insert(a as _, Argument { name, type_: *ty, is_const: true });
871 panic!("unexpected non const in position {pos}");
874 _ => panic!("invalid arg index"),
880 fn clean_function<'tcx>(
881 cx: &mut DocContext<'tcx>,
882 sig: &hir::FnSig<'tcx>,
883 generics: &hir::Generics<'tcx>,
884 body_id: hir::BodyId,
886 let (generics, decl) = enter_impl_trait(cx, |cx| {
887 // NOTE: generics must be cleaned before args
888 let generics = clean_generics(generics, cx);
889 let args = clean_args_from_types_and_body_id(cx, sig.decl.inputs, body_id);
890 let mut decl = clean_fn_decl_with_args(cx, sig.decl, args);
891 if sig.header.is_async() {
892 decl.output = decl.sugared_async_return_type();
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(box QPathData { 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);
1331 Type::QPath(Box::new(QPathData {
1332 assoc: clean_path_segment(p.segments.last().expect("segments were empty"), cx),
1338 hir::QPath::TypeRelative(qself, segment) => {
1339 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1340 let res = match ty.kind() {
1341 ty::Projection(proj) => Res::Def(DefKind::Trait, proj.trait_ref(cx.tcx).def_id),
1342 // Rustdoc handles `ty::Error`s by turning them into `Type::Infer`s.
1343 ty::Error(_) => return Type::Infer,
1344 _ => bug!("clean: expected associated type, found `{:?}`", ty),
1346 let trait_ = clean_path(&hir::Path { span, res, segments: &[] }, cx);
1347 register_res(cx, trait_.res);
1348 let self_def_id = res.opt_def_id();
1349 let self_type = clean_ty(qself, cx);
1350 let should_show_cast = compute_should_show_cast(self_def_id, &trait_, &self_type);
1351 Type::QPath(Box::new(QPathData {
1352 assoc: clean_path_segment(segment, cx),
1358 hir::QPath::LangItem(..) => bug!("clean: requiring documentation of lang item"),
1362 fn maybe_expand_private_type_alias<'tcx>(
1363 cx: &mut DocContext<'tcx>,
1364 path: &hir::Path<'tcx>,
1366 let Res::Def(DefKind::TyAlias, def_id) = path.res else { return None };
1367 // Substitute private type aliases
1368 let def_id = def_id.as_local()?;
1369 let alias = if !cx.cache.access_levels.is_exported(def_id.to_def_id()) {
1370 &cx.tcx.hir().expect_item(def_id).kind
1374 let hir::ItemKind::TyAlias(ty, generics) = alias else { return None };
1376 let provided_params = &path.segments.last().expect("segments were empty");
1377 let mut substs = FxHashMap::default();
1378 let generic_args = provided_params.args();
1380 let mut indices: hir::GenericParamCount = Default::default();
1381 for param in generics.params.iter() {
1383 hir::GenericParamKind::Lifetime { .. } => {
1385 let lifetime = generic_args.args.iter().find_map(|arg| match arg {
1386 hir::GenericArg::Lifetime(lt) => {
1387 if indices.lifetimes == j {
1395 if let Some(lt) = lifetime.cloned() {
1396 let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1398 if !lt.is_elided() { clean_lifetime(lt, cx) } else { Lifetime::elided() };
1399 substs.insert(lt_def_id.to_def_id(), SubstParam::Lifetime(cleaned));
1401 indices.lifetimes += 1;
1403 hir::GenericParamKind::Type { ref default, .. } => {
1404 let ty_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1406 let type_ = generic_args.args.iter().find_map(|arg| match arg {
1407 hir::GenericArg::Type(ty) => {
1408 if indices.types == j {
1416 if let Some(ty) = type_ {
1417 substs.insert(ty_param_def_id.to_def_id(), SubstParam::Type(clean_ty(ty, cx)));
1418 } else if let Some(default) = *default {
1420 ty_param_def_id.to_def_id(),
1421 SubstParam::Type(clean_ty(default, cx)),
1426 hir::GenericParamKind::Const { .. } => {
1427 let const_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1429 let const_ = generic_args.args.iter().find_map(|arg| match arg {
1430 hir::GenericArg::Const(ct) => {
1431 if indices.consts == j {
1439 if let Some(ct) = const_ {
1441 const_param_def_id.to_def_id(),
1442 SubstParam::Constant(clean_const(ct, cx)),
1445 // FIXME(const_generics_defaults)
1446 indices.consts += 1;
1451 Some(cx.enter_alias(substs, |cx| clean_ty(ty, cx)))
1454 pub(crate) fn clean_ty<'tcx>(ty: &hir::Ty<'tcx>, cx: &mut DocContext<'tcx>) -> Type {
1458 TyKind::Never => Primitive(PrimitiveType::Never),
1459 TyKind::Ptr(ref m) => RawPointer(m.mutbl, Box::new(clean_ty(m.ty, cx))),
1460 TyKind::Rptr(ref l, ref m) => {
1461 // There are two times a `Fresh` lifetime can be created:
1462 // 1. For `&'_ x`, written by the user. This corresponds to `lower_lifetime` in `rustc_ast_lowering`.
1463 // 2. For `&x` as a parameter to an `async fn`. This corresponds to `elided_ref_lifetime in `rustc_ast_lowering`.
1464 // See #59286 for more information.
1465 // Ideally we would only hide the `'_` for case 2., but I don't know a way to distinguish it.
1466 // Turning `fn f(&'_ self)` into `fn f(&self)` isn't the worst thing in the world, though;
1467 // there's no case where it could cause the function to fail to compile.
1469 l.is_elided() || matches!(l.name, LifetimeName::Param(_, ParamName::Fresh));
1470 let lifetime = if elided { None } else { Some(clean_lifetime(*l, cx)) };
1471 BorrowedRef { lifetime, mutability: m.mutbl, type_: Box::new(clean_ty(m.ty, cx)) }
1473 TyKind::Slice(ty) => Slice(Box::new(clean_ty(ty, cx))),
1474 TyKind::Array(ty, ref length) => {
1475 let length = match length {
1476 hir::ArrayLen::Infer(_, _) => "_".to_string(),
1477 hir::ArrayLen::Body(anon_const) => {
1478 let def_id = cx.tcx.hir().local_def_id(anon_const.hir_id);
1479 // NOTE(min_const_generics): We can't use `const_eval_poly` for constants
1480 // as we currently do not supply the parent generics to anonymous constants
1481 // but do allow `ConstKind::Param`.
1483 // `const_eval_poly` tries to to first substitute generic parameters which
1484 // results in an ICE while manually constructing the constant and using `eval`
1485 // does nothing for `ConstKind::Param`.
1486 let ct = ty::Const::from_anon_const(cx.tcx, def_id);
1487 let param_env = cx.tcx.param_env(def_id);
1488 print_const(cx, ct.eval(cx.tcx, param_env))
1492 Array(Box::new(clean_ty(ty, cx)), length)
1494 TyKind::Tup(tys) => Tuple(tys.iter().map(|ty| clean_ty(ty, cx)).collect()),
1495 TyKind::OpaqueDef(item_id, _) => {
1496 let item = cx.tcx.hir().item(item_id);
1497 if let hir::ItemKind::OpaqueTy(ref ty) = item.kind {
1498 ImplTrait(ty.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect())
1503 TyKind::Path(_) => clean_qpath(ty, cx),
1504 TyKind::TraitObject(bounds, ref lifetime, _) => {
1505 let bounds = bounds.iter().map(|bound| clean_poly_trait_ref(bound, cx)).collect();
1507 if !lifetime.is_elided() { Some(clean_lifetime(*lifetime, cx)) } else { None };
1508 DynTrait(bounds, lifetime)
1510 TyKind::BareFn(barefn) => BareFunction(Box::new(clean_bare_fn_ty(barefn, cx))),
1511 // Rustdoc handles `TyKind::Err`s by turning them into `Type::Infer`s.
1512 TyKind::Infer | TyKind::Err => Infer,
1513 TyKind::Typeof(..) => panic!("unimplemented type {:?}", ty.kind),
1517 /// Returns `None` if the type could not be normalized
1518 fn normalize<'tcx>(cx: &mut DocContext<'tcx>, ty: Ty<'_>) -> Option<Ty<'tcx>> {
1519 // HACK: low-churn fix for #79459 while we wait for a trait normalization fix
1520 if !cx.tcx.sess.opts.unstable_opts.normalize_docs {
1524 use crate::rustc_trait_selection::infer::TyCtxtInferExt;
1525 use crate::rustc_trait_selection::traits::query::normalize::AtExt;
1526 use rustc_middle::traits::ObligationCause;
1528 // Try to normalize `<X as Y>::T` to a type
1529 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
1530 let normalized = cx.tcx.infer_ctxt().enter(|infcx| {
1532 .at(&ObligationCause::dummy(), cx.param_env)
1534 .map(|resolved| infcx.resolve_vars_if_possible(resolved.value))
1537 Ok(normalized_value) => {
1538 debug!("normalized {:?} to {:?}", ty, normalized_value);
1539 Some(normalized_value)
1542 debug!("failed to normalize {:?}: {:?}", ty, err);
1548 pub(crate) fn clean_middle_ty<'tcx>(
1550 cx: &mut DocContext<'tcx>,
1551 def_id: Option<DefId>,
1553 trace!("cleaning type: {:?}", this);
1554 let ty = normalize(cx, this).unwrap_or(this);
1556 ty::Never => Primitive(PrimitiveType::Never),
1557 ty::Bool => Primitive(PrimitiveType::Bool),
1558 ty::Char => Primitive(PrimitiveType::Char),
1559 ty::Int(int_ty) => Primitive(int_ty.into()),
1560 ty::Uint(uint_ty) => Primitive(uint_ty.into()),
1561 ty::Float(float_ty) => Primitive(float_ty.into()),
1562 ty::Str => Primitive(PrimitiveType::Str),
1563 ty::Slice(ty) => Slice(Box::new(clean_middle_ty(ty, cx, None))),
1564 ty::Array(ty, n) => {
1565 let mut n = cx.tcx.lift(n).expect("array lift failed");
1566 n = n.eval(cx.tcx, ty::ParamEnv::reveal_all());
1567 let n = print_const(cx, n);
1568 Array(Box::new(clean_middle_ty(ty, cx, None)), n)
1570 ty::RawPtr(mt) => RawPointer(mt.mutbl, Box::new(clean_middle_ty(mt.ty, cx, None))),
1571 ty::Ref(r, ty, mutbl) => BorrowedRef {
1572 lifetime: clean_middle_region(r),
1574 type_: Box::new(clean_middle_ty(ty, cx, None)),
1576 ty::FnDef(..) | ty::FnPtr(_) => {
1577 let ty = cx.tcx.lift(this).expect("FnPtr lift failed");
1578 let sig = ty.fn_sig(cx.tcx);
1579 let decl = clean_fn_decl_from_did_and_sig(cx, None, sig);
1580 BareFunction(Box::new(BareFunctionDecl {
1581 unsafety: sig.unsafety(),
1582 generic_params: Vec::new(),
1587 ty::Adt(def, substs) => {
1588 let did = def.did();
1589 let kind = match def.adt_kind() {
1590 AdtKind::Struct => ItemType::Struct,
1591 AdtKind::Union => ItemType::Union,
1592 AdtKind::Enum => ItemType::Enum,
1594 inline::record_extern_fqn(cx, did, kind);
1595 let path = external_path(cx, did, false, ThinVec::new(), substs);
1598 ty::Foreign(did) => {
1599 inline::record_extern_fqn(cx, did, ItemType::ForeignType);
1600 let path = external_path(cx, did, false, ThinVec::new(), InternalSubsts::empty());
1603 ty::Dynamic(obj, ref reg) => {
1604 // HACK: pick the first `did` as the `did` of the trait object. Someone
1605 // might want to implement "native" support for marker-trait-only
1607 let mut dids = obj.auto_traits();
1610 .or_else(|| dids.next())
1611 .unwrap_or_else(|| panic!("found trait object `{:?}` with no traits?", this));
1612 let substs = match obj.principal() {
1613 Some(principal) => principal.skip_binder().substs,
1614 // marker traits have no substs.
1615 _ => cx.tcx.intern_substs(&[]),
1618 inline::record_extern_fqn(cx, did, ItemType::Trait);
1620 let lifetime = clean_middle_region(*reg);
1621 let mut bounds = dids
1623 let empty = cx.tcx.intern_substs(&[]);
1624 let path = external_path(cx, did, false, ThinVec::new(), empty);
1625 inline::record_extern_fqn(cx, did, ItemType::Trait);
1626 PolyTrait { trait_: path, generic_params: Vec::new() }
1628 .collect::<Vec<_>>();
1631 .projection_bounds()
1632 .map(|pb| TypeBinding {
1633 assoc: projection_to_path_segment(
1635 .lift_to_tcx(cx.tcx)
1637 // HACK(compiler-errors): Doesn't actually matter what self
1638 // type we put here, because we're only using the GAT's substs.
1639 .with_self_ty(cx.tcx, cx.tcx.types.self_param)
1643 kind: TypeBindingKind::Equality {
1644 term: clean_middle_term(pb.skip_binder().term, cx),
1649 let path = external_path(cx, did, false, bindings, substs);
1650 bounds.insert(0, PolyTrait { trait_: path, generic_params: Vec::new() });
1652 DynTrait(bounds, lifetime)
1654 ty::Tuple(t) => Tuple(t.iter().map(|t| clean_middle_ty(t, cx, None)).collect()),
1656 ty::Projection(ref data) => clean_projection(*data, cx, def_id),
1658 ty::Param(ref p) => {
1659 if let Some(bounds) = cx.impl_trait_bounds.remove(&p.index.into()) {
1666 ty::Opaque(def_id, substs) => {
1667 // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
1668 // by looking up the bounds associated with the def_id.
1669 let substs = cx.tcx.lift(substs).expect("Opaque lift failed");
1672 .explicit_item_bounds(def_id)
1674 .map(|(bound, _)| EarlyBinder(*bound).subst(cx.tcx, substs))
1675 .collect::<Vec<_>>();
1676 let mut regions = vec![];
1677 let mut has_sized = false;
1678 let mut bounds = bounds
1680 .filter_map(|bound| {
1681 let bound_predicate = bound.kind();
1682 let trait_ref = match bound_predicate.skip_binder() {
1683 ty::PredicateKind::Trait(tr) => bound_predicate.rebind(tr.trait_ref),
1684 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(_ty, reg)) => {
1685 if let Some(r) = clean_middle_region(reg) {
1686 regions.push(GenericBound::Outlives(r));
1693 if let Some(sized) = cx.tcx.lang_items().sized_trait() {
1694 if trait_ref.def_id() == sized {
1700 let bindings: ThinVec<_> = bounds
1702 .filter_map(|bound| {
1703 if let ty::PredicateKind::Projection(proj) = bound.kind().skip_binder()
1705 if proj.projection_ty.trait_ref(cx.tcx) == trait_ref.skip_binder() {
1707 assoc: projection_to_path_segment(proj.projection_ty, cx),
1708 kind: TypeBindingKind::Equality {
1709 term: clean_middle_term(proj.term, cx),
1721 Some(clean_poly_trait_ref_with_bindings(cx, trait_ref, bindings))
1723 .collect::<Vec<_>>();
1724 bounds.extend(regions);
1725 if !has_sized && !bounds.is_empty() {
1726 bounds.insert(0, GenericBound::maybe_sized(cx));
1731 ty::Closure(..) => panic!("Closure"),
1732 ty::Generator(..) => panic!("Generator"),
1733 ty::Bound(..) => panic!("Bound"),
1734 ty::Placeholder(..) => panic!("Placeholder"),
1735 ty::GeneratorWitness(..) => panic!("GeneratorWitness"),
1736 ty::Infer(..) => panic!("Infer"),
1737 ty::Error(_) => panic!("Error"),
1741 pub(crate) fn clean_field<'tcx>(field: &hir::FieldDef<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1742 let def_id = cx.tcx.hir().local_def_id(field.hir_id).to_def_id();
1743 clean_field_with_def_id(def_id, field.ident.name, clean_ty(field.ty, cx), cx)
1746 pub(crate) fn clean_middle_field<'tcx>(field: &ty::FieldDef, cx: &mut DocContext<'tcx>) -> Item {
1747 clean_field_with_def_id(
1750 clean_middle_ty(cx.tcx.type_of(field.did), cx, Some(field.did)),
1755 pub(crate) fn clean_field_with_def_id(
1759 cx: &mut DocContext<'_>,
1761 let what_rustc_thinks =
1762 Item::from_def_id_and_parts(def_id, Some(name), StructFieldItem(ty), cx);
1763 if is_field_vis_inherited(cx.tcx, def_id) {
1764 // Variant fields inherit their enum's visibility.
1765 Item { visibility: Visibility::Inherited, ..what_rustc_thinks }
1771 fn is_field_vis_inherited(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1772 let parent = tcx.parent(def_id);
1773 match tcx.def_kind(parent) {
1774 DefKind::Struct | DefKind::Union => false,
1775 DefKind::Variant => true,
1776 parent_kind => panic!("unexpected parent kind: {:?}", parent_kind),
1780 pub(crate) fn clean_visibility(vis: ty::Visibility) -> Visibility {
1782 ty::Visibility::Public => Visibility::Public,
1783 ty::Visibility::Restricted(module) => Visibility::Restricted(module),
1787 pub(crate) fn clean_variant_def<'tcx>(variant: &ty::VariantDef, cx: &mut DocContext<'tcx>) -> Item {
1788 let kind = match variant.ctor_kind {
1789 CtorKind::Const => Variant::CLike(match variant.discr {
1790 ty::VariantDiscr::Explicit(def_id) => Some(Discriminant { expr: None, value: def_id }),
1791 ty::VariantDiscr::Relative(_) => None,
1793 CtorKind::Fn => Variant::Tuple(
1794 variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1796 CtorKind::Fictive => Variant::Struct(VariantStruct {
1797 struct_type: CtorKind::Fictive,
1798 fields: variant.fields.iter().map(|field| clean_middle_field(field, cx)).collect(),
1801 let what_rustc_thinks =
1802 Item::from_def_id_and_parts(variant.def_id, Some(variant.name), VariantItem(kind), cx);
1803 // don't show `pub` for variants, which always inherit visibility
1804 Item { visibility: Inherited, ..what_rustc_thinks }
1807 fn clean_variant_data<'tcx>(
1808 variant: &hir::VariantData<'tcx>,
1809 disr_expr: &Option<hir::AnonConst>,
1810 cx: &mut DocContext<'tcx>,
1813 hir::VariantData::Struct(..) => Variant::Struct(VariantStruct {
1814 struct_type: CtorKind::from_hir(variant),
1815 fields: variant.fields().iter().map(|x| clean_field(x, cx)).collect(),
1817 hir::VariantData::Tuple(..) => {
1818 Variant::Tuple(variant.fields().iter().map(|x| clean_field(x, cx)).collect())
1820 hir::VariantData::Unit(..) => Variant::CLike(disr_expr.map(|disr| Discriminant {
1821 expr: Some(disr.body),
1822 value: cx.tcx.hir().local_def_id(disr.hir_id).to_def_id(),
1827 fn clean_path<'tcx>(path: &hir::Path<'tcx>, cx: &mut DocContext<'tcx>) -> Path {
1830 segments: path.segments.iter().map(|x| clean_path_segment(x, cx)).collect(),
1834 fn clean_generic_args<'tcx>(
1835 generic_args: &hir::GenericArgs<'tcx>,
1836 cx: &mut DocContext<'tcx>,
1838 if generic_args.parenthesized {
1839 let output = clean_ty(generic_args.bindings[0].ty(), cx);
1840 let output = if output != Type::Tuple(Vec::new()) { Some(Box::new(output)) } else { None };
1842 generic_args.inputs().iter().map(|x| clean_ty(x, cx)).collect::<Vec<_>>().into();
1843 GenericArgs::Parenthesized { inputs, output }
1845 let args = generic_args
1848 .map(|arg| match arg {
1849 hir::GenericArg::Lifetime(lt) if !lt.is_elided() => {
1850 GenericArg::Lifetime(clean_lifetime(*lt, cx))
1852 hir::GenericArg::Lifetime(_) => GenericArg::Lifetime(Lifetime::elided()),
1853 hir::GenericArg::Type(ty) => GenericArg::Type(clean_ty(ty, cx)),
1854 hir::GenericArg::Const(ct) => GenericArg::Const(Box::new(clean_const(ct, cx))),
1855 hir::GenericArg::Infer(_inf) => GenericArg::Infer,
1857 .collect::<Vec<_>>()
1860 generic_args.bindings.iter().map(|x| clean_type_binding(x, cx)).collect::<ThinVec<_>>();
1861 GenericArgs::AngleBracketed { args, bindings }
1865 fn clean_path_segment<'tcx>(
1866 path: &hir::PathSegment<'tcx>,
1867 cx: &mut DocContext<'tcx>,
1869 PathSegment { name: path.ident.name, args: clean_generic_args(path.args(), cx) }
1872 fn clean_bare_fn_ty<'tcx>(
1873 bare_fn: &hir::BareFnTy<'tcx>,
1874 cx: &mut DocContext<'tcx>,
1875 ) -> BareFunctionDecl {
1876 let (generic_params, decl) = enter_impl_trait(cx, |cx| {
1877 // NOTE: generics must be cleaned before args
1878 let generic_params = bare_fn
1881 .filter(|p| !is_elided_lifetime(p))
1882 .map(|x| clean_generic_param(cx, None, x))
1884 let args = clean_args_from_types_and_names(cx, bare_fn.decl.inputs, bare_fn.param_names);
1885 let decl = clean_fn_decl_with_args(cx, bare_fn.decl, args);
1886 (generic_params, decl)
1888 BareFunctionDecl { unsafety: bare_fn.unsafety, abi: bare_fn.abi, decl, generic_params }
1891 fn clean_maybe_renamed_item<'tcx>(
1892 cx: &mut DocContext<'tcx>,
1893 item: &hir::Item<'tcx>,
1894 renamed: Option<Symbol>,
1898 let def_id = item.def_id.to_def_id();
1899 let mut name = renamed.unwrap_or_else(|| cx.tcx.hir().name(item.hir_id()));
1900 cx.with_param_env(def_id, |cx| {
1901 let kind = match item.kind {
1902 ItemKind::Static(ty, mutability, body_id) => {
1903 StaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: Some(body_id) })
1905 ItemKind::Const(ty, body_id) => ConstantItem(Constant {
1906 type_: clean_ty(ty, cx),
1907 kind: ConstantKind::Local { body: body_id, def_id },
1909 ItemKind::OpaqueTy(ref ty) => OpaqueTyItem(OpaqueTy {
1910 bounds: ty.bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1911 generics: clean_generics(ty.generics, cx),
1913 ItemKind::TyAlias(hir_ty, generics) => {
1914 let rustdoc_ty = clean_ty(hir_ty, cx);
1915 let ty = clean_middle_ty(hir_ty_to_ty(cx.tcx, hir_ty), cx, None);
1916 TypedefItem(Box::new(Typedef {
1918 generics: clean_generics(generics, cx),
1919 item_type: Some(ty),
1922 ItemKind::Enum(ref def, generics) => EnumItem(Enum {
1923 variants: def.variants.iter().map(|v| clean_variant(v, cx)).collect(),
1924 generics: clean_generics(generics, cx),
1926 ItemKind::TraitAlias(generics, bounds) => TraitAliasItem(TraitAlias {
1927 generics: clean_generics(generics, cx),
1928 bounds: bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1930 ItemKind::Union(ref variant_data, generics) => UnionItem(Union {
1931 generics: clean_generics(generics, cx),
1932 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1934 ItemKind::Struct(ref variant_data, generics) => StructItem(Struct {
1935 struct_type: CtorKind::from_hir(variant_data),
1936 generics: clean_generics(generics, cx),
1937 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
1939 ItemKind::Impl(impl_) => return clean_impl(impl_, item.hir_id(), cx),
1940 // proc macros can have a name set by attributes
1941 ItemKind::Fn(ref sig, generics, body_id) => {
1942 clean_fn_or_proc_macro(item, sig, generics, body_id, &mut name, cx)
1944 ItemKind::Macro(ref macro_def, _) => {
1945 let ty_vis = clean_visibility(cx.tcx.visibility(def_id));
1947 source: display_macro_source(cx, name, macro_def, def_id, ty_vis),
1950 ItemKind::Trait(_, _, generics, bounds, item_ids) => {
1951 let items = item_ids
1953 .map(|ti| clean_trait_item(cx.tcx.hir().trait_item(ti.id), cx))
1956 TraitItem(Box::new(Trait {
1959 generics: clean_generics(generics, cx),
1960 bounds: bounds.iter().filter_map(|x| clean_generic_bound(x, cx)).collect(),
1963 ItemKind::ExternCrate(orig_name) => {
1964 return clean_extern_crate(item, name, orig_name, cx);
1966 ItemKind::Use(path, kind) => {
1967 return clean_use_statement(item, name, path, kind, cx, &mut FxHashSet::default());
1969 _ => unreachable!("not yet converted"),
1972 vec![Item::from_def_id_and_parts(def_id, Some(name), kind, cx)]
1976 fn clean_variant<'tcx>(variant: &hir::Variant<'tcx>, cx: &mut DocContext<'tcx>) -> Item {
1977 let kind = VariantItem(clean_variant_data(&variant.data, &variant.disr_expr, cx));
1978 let what_rustc_thinks =
1979 Item::from_hir_id_and_parts(variant.id, Some(variant.ident.name), kind, cx);
1980 // don't show `pub` for variants, which are always public
1981 Item { visibility: Inherited, ..what_rustc_thinks }
1984 fn clean_impl<'tcx>(
1985 impl_: &hir::Impl<'tcx>,
1987 cx: &mut DocContext<'tcx>,
1990 let mut ret = Vec::new();
1991 let trait_ = impl_.of_trait.as_ref().map(|t| clean_trait_ref(t, cx));
1995 .map(|ii| clean_impl_item(tcx.hir().impl_item(ii.id), cx))
1996 .collect::<Vec<_>>();
1997 let def_id = tcx.hir().local_def_id(hir_id);
1999 // If this impl block is an implementation of the Deref trait, then we
2000 // need to try inlining the target's inherent impl blocks as well.
2001 if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
2002 build_deref_target_impls(cx, &items, &mut ret);
2005 let for_ = clean_ty(impl_.self_ty, cx);
2006 let type_alias = for_.def_id(&cx.cache).and_then(|did| match tcx.def_kind(did) {
2007 DefKind::TyAlias => Some(clean_middle_ty(tcx.type_of(did), cx, Some(did))),
2010 let mut make_item = |trait_: Option<Path>, for_: Type, items: Vec<Item>| {
2011 let kind = ImplItem(Box::new(Impl {
2012 unsafety: impl_.unsafety,
2013 generics: clean_generics(impl_.generics, cx),
2017 polarity: tcx.impl_polarity(def_id),
2018 kind: if utils::has_doc_flag(tcx, def_id.to_def_id(), sym::fake_variadic) {
2019 ImplKind::FakeVaradic
2024 Item::from_hir_id_and_parts(hir_id, None, kind, cx)
2026 if let Some(type_alias) = type_alias {
2027 ret.push(make_item(trait_.clone(), type_alias, items.clone()));
2029 ret.push(make_item(trait_, for_, items));
2033 fn clean_extern_crate<'tcx>(
2034 krate: &hir::Item<'tcx>,
2036 orig_name: Option<Symbol>,
2037 cx: &mut DocContext<'tcx>,
2039 // this is the ID of the `extern crate` statement
2040 let cnum = cx.tcx.extern_mod_stmt_cnum(krate.def_id).unwrap_or(LOCAL_CRATE);
2041 // this is the ID of the crate itself
2042 let crate_def_id = cnum.as_def_id();
2043 let attrs = cx.tcx.hir().attrs(krate.hir_id());
2044 let ty_vis = cx.tcx.visibility(krate.def_id);
2045 let please_inline = ty_vis.is_public()
2046 && attrs.iter().any(|a| {
2047 a.has_name(sym::doc)
2048 && match a.meta_item_list() {
2049 Some(l) => attr::list_contains_name(&l, sym::inline),
2055 let mut visited = FxHashSet::default();
2057 let res = Res::Def(DefKind::Mod, crate_def_id);
2059 if let Some(items) = inline::try_inline(
2061 cx.tcx.parent_module(krate.hir_id()).to_def_id(),
2062 Some(krate.def_id.to_def_id()),
2072 // FIXME: using `from_def_id_and_kind` breaks `rustdoc/masked` for some reason
2075 attrs: Box::new(Attributes::from_ast(attrs)),
2076 item_id: crate_def_id.into(),
2077 visibility: clean_visibility(ty_vis),
2078 kind: Box::new(ExternCrateItem { src: orig_name }),
2079 cfg: attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
2083 fn clean_use_statement<'tcx>(
2084 import: &hir::Item<'tcx>,
2086 path: &hir::Path<'tcx>,
2088 cx: &mut DocContext<'tcx>,
2089 inlined_names: &mut FxHashSet<(ItemType, Symbol)>,
2091 // We need this comparison because some imports (for std types for example)
2092 // are "inserted" as well but directly by the compiler and they should not be
2093 // taken into account.
2094 if import.span.ctxt().outer_expn_data().kind == ExpnKind::AstPass(AstPass::StdImports) {
2098 let visibility = cx.tcx.visibility(import.def_id);
2099 let attrs = cx.tcx.hir().attrs(import.hir_id());
2100 let inline_attr = attrs.lists(sym::doc).get_word_attr(sym::inline);
2101 let pub_underscore = visibility.is_public() && name == kw::Underscore;
2102 let current_mod = cx.tcx.parent_module_from_def_id(import.def_id);
2104 // The parent of the module in which this import resides. This
2105 // is the same as `current_mod` if that's already the top
2107 let parent_mod = cx.tcx.parent_module_from_def_id(current_mod);
2109 // This checks if the import can be seen from a higher level module.
2110 // In other words, it checks if the visibility is the equivalent of
2111 // `pub(super)` or higher. If the current module is the top level
2112 // module, there isn't really a parent module, which makes the results
2113 // meaningless. In this case, we make sure the answer is `false`.
2114 let is_visible_from_parent_mod = visibility.is_accessible_from(parent_mod.to_def_id(), cx.tcx)
2115 && !current_mod.is_top_level_module();
2118 if let Some(ref inline) = inline_attr {
2119 rustc_errors::struct_span_err!(
2123 "anonymous imports cannot be inlined"
2125 .span_label(import.span, "anonymous import")
2130 // We consider inlining the documentation of `pub use` statements, but we
2131 // forcefully don't inline if this is not public or if the
2132 // #[doc(no_inline)] attribute is present.
2133 // Don't inline doc(hidden) imports so they can be stripped at a later stage.
2134 let mut denied = cx.output_format.is_json()
2135 || !(visibility.is_public()
2136 || (cx.render_options.document_private && is_visible_from_parent_mod))
2138 || attrs.iter().any(|a| {
2139 a.has_name(sym::doc)
2140 && match a.meta_item_list() {
2142 attr::list_contains_name(&l, sym::no_inline)
2143 || attr::list_contains_name(&l, sym::hidden)
2149 // Also check whether imports were asked to be inlined, in case we're trying to re-export a
2150 // crate in Rust 2018+
2151 let path = clean_path(path, cx);
2152 let inner = if kind == hir::UseKind::Glob {
2154 let mut visited = FxHashSet::default();
2155 if let Some(items) = inline::try_inline_glob(cx, path.res, &mut visited, inlined_names)
2160 Import::new_glob(resolve_use_source(cx, path), true)
2162 if inline_attr.is_none() {
2163 if let Res::Def(DefKind::Mod, did) = path.res {
2164 if !did.is_local() && did.is_crate_root() {
2165 // if we're `pub use`ing an extern crate root, don't inline it unless we
2166 // were specifically asked for it
2172 let mut visited = FxHashSet::default();
2173 let import_def_id = import.def_id.to_def_id();
2175 if let Some(mut items) = inline::try_inline(
2177 cx.tcx.parent_module(import.hir_id()).to_def_id(),
2178 Some(import_def_id),
2184 items.push(Item::from_def_id_and_parts(
2187 ImportItem(Import::new_simple(name, resolve_use_source(cx, path), false)),
2193 Import::new_simple(name, resolve_use_source(cx, path), true)
2196 vec![Item::from_def_id_and_parts(import.def_id.to_def_id(), None, ImportItem(inner), cx)]
2199 fn clean_maybe_renamed_foreign_item<'tcx>(
2200 cx: &mut DocContext<'tcx>,
2201 item: &hir::ForeignItem<'tcx>,
2202 renamed: Option<Symbol>,
2204 let def_id = item.def_id.to_def_id();
2205 cx.with_param_env(def_id, |cx| {
2206 let kind = match item.kind {
2207 hir::ForeignItemKind::Fn(decl, names, generics) => {
2208 let (generics, decl) = enter_impl_trait(cx, |cx| {
2209 // NOTE: generics must be cleaned before args
2210 let generics = clean_generics(generics, cx);
2211 let args = clean_args_from_types_and_names(cx, decl.inputs, names);
2212 let decl = clean_fn_decl_with_args(cx, decl, args);
2215 ForeignFunctionItem(Box::new(Function { decl, generics }))
2217 hir::ForeignItemKind::Static(ty, mutability) => {
2218 ForeignStaticItem(Static { type_: clean_ty(ty, cx), mutability, expr: None })
2220 hir::ForeignItemKind::Type => ForeignTypeItem,
2223 Item::from_hir_id_and_parts(
2225 Some(renamed.unwrap_or(item.ident.name)),
2232 fn clean_type_binding<'tcx>(
2233 type_binding: &hir::TypeBinding<'tcx>,
2234 cx: &mut DocContext<'tcx>,
2237 assoc: PathSegment {
2238 name: type_binding.ident.name,
2239 args: clean_generic_args(type_binding.gen_args, cx),
2241 kind: match type_binding.kind {
2242 hir::TypeBindingKind::Equality { ref term } => {
2243 TypeBindingKind::Equality { term: clean_hir_term(term, cx) }
2245 hir::TypeBindingKind::Constraint { bounds } => TypeBindingKind::Constraint {
2246 bounds: bounds.iter().filter_map(|b| clean_generic_bound(b, cx)).collect(),