1 //! This module contains the "cleaned" pieces of the AST, and the functions
13 use rustc_attr as attr;
14 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
16 use rustc_hir::def::{CtorKind, DefKind, Res};
17 use rustc_hir::def_id::{CrateNum, DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
18 use rustc_index::vec::{Idx, IndexVec};
19 use rustc_infer::infer::region_constraints::{Constraint, RegionConstraintData};
20 use rustc_middle::bug;
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, Lift, Ty, TyCtxt};
25 use rustc_mir::const_eval::{is_const_fn, is_min_const_fn, is_unstable_const_fn};
26 use rustc_span::hygiene::{AstPass, MacroKind};
27 use rustc_span::symbol::{kw, sym, Ident, Symbol};
28 use rustc_span::{self, ExpnKind, Pos};
29 use rustc_typeck::hir_ty_to_ty;
31 use std::collections::hash_map::Entry;
32 use std::default::Default;
37 use crate::core::{self, DocContext, ImplTraitParam};
42 crate use utils::{get_auto_trait_and_blanket_impls, krate, register_res};
44 crate use self::types::FnRetTy::*;
45 crate use self::types::ItemKind::*;
46 crate use self::types::SelfTy::*;
47 crate use self::types::Type::*;
48 crate use self::types::Visibility::{Inherited, Public};
49 crate use self::types::*;
51 const FN_OUTPUT_NAME: &str = "Output";
53 crate trait Clean<T> {
54 fn clean(&self, cx: &DocContext<'_>) -> T;
57 impl<T: Clean<U>, U> Clean<Vec<U>> for [T] {
58 fn clean(&self, cx: &DocContext<'_>) -> Vec<U> {
59 self.iter().map(|x| x.clean(cx)).collect()
63 impl<T: Clean<U>, U, V: Idx> Clean<IndexVec<V, U>> for IndexVec<V, T> {
64 fn clean(&self, cx: &DocContext<'_>) -> IndexVec<V, U> {
65 self.iter().map(|x| x.clean(cx)).collect()
69 impl<T: Clean<U>, U> Clean<U> for &T {
70 fn clean(&self, cx: &DocContext<'_>) -> U {
75 impl<T: Clean<U>, U> Clean<U> for Rc<T> {
76 fn clean(&self, cx: &DocContext<'_>) -> U {
81 impl<T: Clean<U>, U> Clean<Option<U>> for Option<T> {
82 fn clean(&self, cx: &DocContext<'_>) -> Option<U> {
83 self.as_ref().map(|v| v.clean(cx))
87 impl Clean<ExternalCrate> for CrateNum {
88 fn clean(&self, cx: &DocContext<'_>) -> ExternalCrate {
89 let root = DefId { krate: *self, index: CRATE_DEF_INDEX };
90 let krate_span = cx.tcx.def_span(root);
91 let krate_src = cx.sess().source_map().span_to_filename(krate_span);
93 // Collect all inner modules which are tagged as implementations of
96 // Note that this loop only searches the top-level items of the crate,
97 // and this is intentional. If we were to search the entire crate for an
98 // item tagged with `#[doc(primitive)]` then we would also have to
99 // search the entirety of external modules for items tagged
100 // `#[doc(primitive)]`, which is a pretty inefficient process (decoding
101 // all that metadata unconditionally).
103 // In order to keep the metadata load under control, the
104 // `#[doc(primitive)]` feature is explicitly designed to only allow the
105 // primitive tags to show up as the top level items in a crate.
107 // Also note that this does not attempt to deal with modules tagged
108 // duplicately for the same primitive. This is handled later on when
109 // rendering by delegating everything to a hash map.
110 let as_primitive = |res: Res| {
111 if let Res::Def(DefKind::Mod, def_id) = res {
112 let attrs = cx.tcx.get_attrs(def_id).clean(cx);
114 for attr in attrs.lists(sym::doc) {
115 if let Some(v) = attr.value_str() {
116 if attr.has_name(sym::primitive) {
117 prim = PrimitiveType::from_symbol(v);
121 // FIXME: should warn on unknown primitives?
125 return prim.map(|p| (def_id, p));
129 let primitives = if root.is_local() {
138 let item = cx.tcx.hir().expect_item(id.id);
140 hir::ItemKind::Mod(_) => as_primitive(Res::Def(
142 cx.tcx.hir().local_def_id(id.id).to_def_id(),
144 hir::ItemKind::Use(ref path, hir::UseKind::Single)
145 if item.vis.node.is_pub() =>
147 as_primitive(path.res).map(|(_, prim)| {
148 // Pretend the primitive is local.
149 (cx.tcx.hir().local_def_id(id.id).to_def_id(), prim)
160 .map(|item| item.res)
161 .filter_map(as_primitive)
165 let as_keyword = |res: Res| {
166 if let Res::Def(DefKind::Mod, def_id) = res {
167 let attrs = cx.tcx.get_attrs(def_id).clean(cx);
168 let mut keyword = None;
169 for attr in attrs.lists(sym::doc) {
170 if let Some(v) = attr.value_str() {
171 if attr.has_name(sym::keyword) {
172 if v.is_doc_keyword() {
173 keyword = Some(v.to_string());
176 // FIXME: should warn on unknown keywords?
180 return keyword.map(|p| (def_id, p));
184 let keywords = if root.is_local() {
193 let item = cx.tcx.hir().expect_item(id.id);
195 hir::ItemKind::Mod(_) => as_keyword(Res::Def(
197 cx.tcx.hir().local_def_id(id.id).to_def_id(),
199 hir::ItemKind::Use(ref path, hir::UseKind::Single)
200 if item.vis.node.is_pub() =>
202 as_keyword(path.res).map(|(_, prim)| {
203 (cx.tcx.hir().local_def_id(id.id).to_def_id(), prim)
211 cx.tcx.item_children(root).iter().map(|item| item.res).filter_map(as_keyword).collect()
215 name: cx.tcx.crate_name(*self).to_string(),
217 attrs: cx.tcx.get_attrs(root).clean(cx),
224 impl Clean<Item> for doctree::Module<'_> {
225 fn clean(&self, cx: &DocContext<'_>) -> Item {
226 // maintain a stack of mod ids, for doc comment path resolution
227 // but we also need to resolve the module's own docs based on whether its docs were written
228 // inside or outside the module, so check for that
229 let attrs = self.attrs.clean(cx);
231 let mut items: Vec<Item> = vec![];
232 items.extend(self.imports.iter().flat_map(|x| x.clean(cx)));
233 items.extend(self.foreigns.iter().map(|x| x.clean(cx)));
234 items.extend(self.mods.iter().map(|x| x.clean(cx)));
235 items.extend(self.items.iter().map(|x| x.clean(cx)).flatten());
236 items.extend(self.macros.iter().map(|x| x.clean(cx)));
238 // determine if we should display the inner contents or
239 // the outer `mod` item for the source code.
241 let sm = cx.sess().source_map();
242 let outer = sm.lookup_char_pos(self.where_outer.lo());
243 let inner = sm.lookup_char_pos(self.where_inner.lo());
244 if outer.file.start_pos == inner.file.start_pos {
248 // mod foo; (and a separate SourceFile for the contents)
253 let what_rustc_thinks = Item::from_hir_id_and_parts(
256 ModuleItem(Module { is_crate: self.is_crate, items }),
260 name: Some(what_rustc_thinks.name.unwrap_or_default()),
262 source: span.clean(cx),
268 impl Clean<Attributes> for [ast::Attribute] {
269 fn clean(&self, cx: &DocContext<'_>) -> Attributes {
270 Attributes::from_ast(cx.sess().diagnostic(), self, None)
274 impl Clean<GenericBound> for hir::GenericBound<'_> {
275 fn clean(&self, cx: &DocContext<'_>) -> GenericBound {
277 hir::GenericBound::Outlives(lt) => GenericBound::Outlives(lt.clean(cx)),
278 hir::GenericBound::LangItemTrait(lang_item, span, _, generic_args) => {
279 let def_id = cx.tcx.require_lang_item(lang_item, Some(span));
281 let trait_ref = ty::TraitRef::identity(cx.tcx, def_id);
283 let generic_args = generic_args.clean(cx);
284 let bindings = match generic_args {
285 GenericArgs::AngleBracketed { bindings, .. } => bindings,
286 _ => bug!("clean: parenthesized `GenericBound::LangItemTrait`"),
289 GenericBound::TraitBound(
290 PolyTrait { trait_: (trait_ref, &*bindings).clean(cx), generic_params: vec![] },
291 hir::TraitBoundModifier::None,
294 hir::GenericBound::Trait(ref t, modifier) => {
295 GenericBound::TraitBound(t.clean(cx), modifier)
301 impl Clean<Type> for (ty::TraitRef<'_>, &[TypeBinding]) {
302 fn clean(&self, cx: &DocContext<'_>) -> Type {
303 let (trait_ref, bounds) = *self;
304 inline::record_extern_fqn(cx, trait_ref.def_id, TypeKind::Trait);
305 let path = external_path(
307 cx.tcx.item_name(trait_ref.def_id),
308 Some(trait_ref.def_id),
314 debug!("ty::TraitRef\n subst: {:?}\n", trait_ref.substs);
316 ResolvedPath { path, param_names: None, did: trait_ref.def_id, is_generic: false }
320 impl<'tcx> Clean<GenericBound> for ty::TraitRef<'tcx> {
321 fn clean(&self, cx: &DocContext<'_>) -> GenericBound {
322 GenericBound::TraitBound(
323 PolyTrait { trait_: (*self, &[][..]).clean(cx), generic_params: vec![] },
324 hir::TraitBoundModifier::None,
329 impl Clean<GenericBound> for (ty::PolyTraitRef<'_>, &[TypeBinding]) {
330 fn clean(&self, cx: &DocContext<'_>) -> GenericBound {
331 let (poly_trait_ref, bounds) = *self;
332 let poly_trait_ref = poly_trait_ref.lift_to_tcx(cx.tcx).unwrap();
334 // collect any late bound regions
335 let late_bound_regions: Vec<_> = cx
337 .collect_referenced_late_bound_regions(&poly_trait_ref)
339 .filter_map(|br| match br {
340 ty::BrNamed(_, name) => Some(GenericParamDef {
341 name: name.to_string(),
342 kind: GenericParamDefKind::Lifetime,
348 GenericBound::TraitBound(
350 trait_: (poly_trait_ref.skip_binder(), bounds).clean(cx),
351 generic_params: late_bound_regions,
353 hir::TraitBoundModifier::None,
358 impl<'tcx> Clean<GenericBound> for ty::PolyTraitRef<'tcx> {
359 fn clean(&self, cx: &DocContext<'_>) -> GenericBound {
360 (*self, &[][..]).clean(cx)
364 impl<'tcx> Clean<Option<Vec<GenericBound>>> for InternalSubsts<'tcx> {
365 fn clean(&self, cx: &DocContext<'_>) -> Option<Vec<GenericBound>> {
366 let mut v = Vec::new();
367 v.extend(self.regions().filter_map(|r| r.clean(cx)).map(GenericBound::Outlives));
368 v.extend(self.types().map(|t| {
369 GenericBound::TraitBound(
370 PolyTrait { trait_: t.clean(cx), generic_params: Vec::new() },
371 hir::TraitBoundModifier::None,
374 if !v.is_empty() { Some(v) } else { None }
378 impl Clean<Lifetime> for hir::Lifetime {
379 fn clean(&self, cx: &DocContext<'_>) -> Lifetime {
380 let def = cx.tcx.named_region(self.hir_id);
383 rl::Region::EarlyBound(_, node_id, _)
384 | rl::Region::LateBound(_, node_id, _)
385 | rl::Region::Free(_, node_id),
387 if let Some(lt) = cx.lt_substs.borrow().get(&node_id).cloned() {
393 Lifetime(self.name.ident().to_string())
397 impl Clean<Lifetime> for hir::GenericParam<'_> {
398 fn clean(&self, _: &DocContext<'_>) -> Lifetime {
400 hir::GenericParamKind::Lifetime { .. } => {
401 if !self.bounds.is_empty() {
402 let mut bounds = self.bounds.iter().map(|bound| match bound {
403 hir::GenericBound::Outlives(lt) => lt,
406 let name = bounds.next().expect("no more bounds").name.ident();
407 let mut s = format!("{}: {}", self.name.ident(), name);
408 for bound in bounds {
409 s.push_str(&format!(" + {}", bound.name.ident()));
413 Lifetime(self.name.ident().to_string())
421 impl Clean<Constant> for hir::ConstArg {
422 fn clean(&self, cx: &DocContext<'_>) -> Constant {
426 .type_of(cx.tcx.hir().body_owner_def_id(self.value.body).to_def_id())
428 expr: print_const_expr(cx, self.value.body),
430 is_literal: is_literal_expr(cx, self.value.body.hir_id),
435 impl Clean<Lifetime> for ty::GenericParamDef {
436 fn clean(&self, _cx: &DocContext<'_>) -> Lifetime {
437 Lifetime(self.name.to_string())
441 impl Clean<Option<Lifetime>> for ty::RegionKind {
442 fn clean(&self, cx: &DocContext<'_>) -> Option<Lifetime> {
444 ty::ReStatic => Some(Lifetime::statik()),
445 ty::ReLateBound(_, ty::BrNamed(_, name)) => Some(Lifetime(name.to_string())),
446 ty::ReEarlyBound(ref data) => Some(Lifetime(data.name.clean(cx))),
451 | ty::RePlaceholder(..)
454 debug!("cannot clean region {:?}", self);
461 impl Clean<WherePredicate> for hir::WherePredicate<'_> {
462 fn clean(&self, cx: &DocContext<'_>) -> WherePredicate {
464 hir::WherePredicate::BoundPredicate(ref wbp) => WherePredicate::BoundPredicate {
465 ty: wbp.bounded_ty.clean(cx),
466 bounds: wbp.bounds.clean(cx),
469 hir::WherePredicate::RegionPredicate(ref wrp) => WherePredicate::RegionPredicate {
470 lifetime: wrp.lifetime.clean(cx),
471 bounds: wrp.bounds.clean(cx),
474 hir::WherePredicate::EqPredicate(ref wrp) => {
475 WherePredicate::EqPredicate { lhs: wrp.lhs_ty.clean(cx), rhs: wrp.rhs_ty.clean(cx) }
481 impl<'a> Clean<Option<WherePredicate>> for ty::Predicate<'a> {
482 fn clean(&self, cx: &DocContext<'_>) -> Option<WherePredicate> {
483 match self.skip_binders() {
484 ty::PredicateAtom::Trait(pred, _) => Some(ty::Binder::bind(pred).clean(cx)),
485 ty::PredicateAtom::RegionOutlives(pred) => pred.clean(cx),
486 ty::PredicateAtom::TypeOutlives(pred) => pred.clean(cx),
487 ty::PredicateAtom::Projection(pred) => Some(pred.clean(cx)),
489 ty::PredicateAtom::Subtype(..)
490 | ty::PredicateAtom::WellFormed(..)
491 | ty::PredicateAtom::ObjectSafe(..)
492 | ty::PredicateAtom::ClosureKind(..)
493 | ty::PredicateAtom::ConstEvaluatable(..)
494 | ty::PredicateAtom::ConstEquate(..)
495 | ty::PredicateAtom::TypeWellFormedFromEnv(..) => panic!("not user writable"),
500 impl<'a> Clean<WherePredicate> for ty::PolyTraitPredicate<'a> {
501 fn clean(&self, cx: &DocContext<'_>) -> WherePredicate {
502 let poly_trait_ref = self.map_bound(|pred| pred.trait_ref);
503 WherePredicate::BoundPredicate {
504 ty: poly_trait_ref.skip_binder().self_ty().clean(cx),
505 bounds: vec![poly_trait_ref.clean(cx)],
510 impl<'tcx> Clean<Option<WherePredicate>>
511 for ty::OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>
513 fn clean(&self, cx: &DocContext<'_>) -> Option<WherePredicate> {
514 let ty::OutlivesPredicate(a, b) = self;
516 if let (ty::ReEmpty(_), ty::ReEmpty(_)) = (a, b) {
520 Some(WherePredicate::RegionPredicate {
521 lifetime: a.clean(cx).expect("failed to clean lifetime"),
522 bounds: vec![GenericBound::Outlives(b.clean(cx).expect("failed to clean bounds"))],
527 impl<'tcx> Clean<Option<WherePredicate>> for ty::OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>> {
528 fn clean(&self, cx: &DocContext<'_>) -> Option<WherePredicate> {
529 let ty::OutlivesPredicate(ty, lt) = self;
531 if let ty::ReEmpty(_) = lt {
535 Some(WherePredicate::BoundPredicate {
537 bounds: vec![GenericBound::Outlives(lt.clean(cx).expect("failed to clean lifetimes"))],
542 impl<'tcx> Clean<WherePredicate> for ty::ProjectionPredicate<'tcx> {
543 fn clean(&self, cx: &DocContext<'_>) -> WherePredicate {
544 let ty::ProjectionPredicate { projection_ty, ty } = self;
545 WherePredicate::EqPredicate { lhs: projection_ty.clean(cx), rhs: ty.clean(cx) }
549 impl<'tcx> Clean<Type> for ty::ProjectionTy<'tcx> {
550 fn clean(&self, cx: &DocContext<'_>) -> Type {
551 let lifted = self.lift_to_tcx(cx.tcx).unwrap();
552 let trait_ = match lifted.trait_ref(cx.tcx).clean(cx) {
553 GenericBound::TraitBound(t, _) => t.trait_,
554 GenericBound::Outlives(_) => panic!("cleaning a trait got a lifetime"),
557 name: cx.tcx.associated_item(self.item_def_id).ident.name.clean(cx),
558 self_type: box self.self_ty().clean(cx),
564 impl Clean<GenericParamDef> for ty::GenericParamDef {
565 fn clean(&self, cx: &DocContext<'_>) -> GenericParamDef {
566 let (name, kind) = match self.kind {
567 ty::GenericParamDefKind::Lifetime => {
568 (self.name.to_string(), GenericParamDefKind::Lifetime)
570 ty::GenericParamDefKind::Type { has_default, synthetic, .. } => {
572 if has_default { Some(cx.tcx.type_of(self.def_id).clean(cx)) } else { None };
575 GenericParamDefKind::Type {
577 bounds: vec![], // These are filled in from the where-clauses.
583 ty::GenericParamDefKind::Const { .. } => (
585 GenericParamDefKind::Const {
587 ty: cx.tcx.type_of(self.def_id).clean(cx),
592 GenericParamDef { name, kind }
596 impl Clean<GenericParamDef> for hir::GenericParam<'_> {
597 fn clean(&self, cx: &DocContext<'_>) -> GenericParamDef {
598 let (name, kind) = match self.kind {
599 hir::GenericParamKind::Lifetime { .. } => {
600 let name = if !self.bounds.is_empty() {
601 let mut bounds = self.bounds.iter().map(|bound| match bound {
602 hir::GenericBound::Outlives(lt) => lt,
605 let name = bounds.next().expect("no more bounds").name.ident();
606 let mut s = format!("{}: {}", self.name.ident(), name);
607 for bound in bounds {
608 s.push_str(&format!(" + {}", bound.name.ident()));
612 self.name.ident().to_string()
614 (name, GenericParamDefKind::Lifetime)
616 hir::GenericParamKind::Type { ref default, synthetic } => (
617 self.name.ident().name.clean(cx),
618 GenericParamDefKind::Type {
619 did: cx.tcx.hir().local_def_id(self.hir_id).to_def_id(),
620 bounds: self.bounds.clean(cx),
621 default: default.clean(cx),
625 hir::GenericParamKind::Const { ref ty } => (
626 self.name.ident().name.clean(cx),
627 GenericParamDefKind::Const {
628 did: cx.tcx.hir().local_def_id(self.hir_id).to_def_id(),
634 GenericParamDef { name, kind }
638 impl Clean<Generics> for hir::Generics<'_> {
639 fn clean(&self, cx: &DocContext<'_>) -> Generics {
640 // Synthetic type-parameters are inserted after normal ones.
641 // In order for normal parameters to be able to refer to synthetic ones,
643 fn is_impl_trait(param: &hir::GenericParam<'_>) -> bool {
645 hir::GenericParamKind::Type { synthetic, .. } => {
646 synthetic == Some(hir::SyntheticTyParamKind::ImplTrait)
651 let impl_trait_params = self
654 .filter(|param| is_impl_trait(param))
656 let param: GenericParamDef = param.clean(cx);
658 GenericParamDefKind::Lifetime => unreachable!(),
659 GenericParamDefKind::Type { did, ref bounds, .. } => {
660 cx.impl_trait_bounds.borrow_mut().insert(did.into(), bounds.clone());
662 GenericParamDefKind::Const { .. } => unreachable!(),
666 .collect::<Vec<_>>();
668 let mut params = Vec::with_capacity(self.params.len());
669 for p in self.params.iter().filter(|p| !is_impl_trait(p)) {
673 params.extend(impl_trait_params);
676 Generics { params, where_predicates: self.where_clause.predicates.clean(cx) };
678 // Some duplicates are generated for ?Sized bounds between type params and where
679 // predicates. The point in here is to move the bounds definitions from type params
680 // to where predicates when such cases occur.
681 for where_pred in &mut generics.where_predicates {
683 WherePredicate::BoundPredicate { ty: Generic(ref name), ref mut bounds } => {
684 if bounds.is_empty() {
685 for param in &mut generics.params {
687 GenericParamDefKind::Lifetime => {}
688 GenericParamDefKind::Type { bounds: ref mut ty_bounds, .. } => {
689 if ¶m.name == name {
690 mem::swap(bounds, ty_bounds);
694 GenericParamDefKind::Const { .. } => {}
706 impl<'a, 'tcx> Clean<Generics> for (&'a ty::Generics, ty::GenericPredicates<'tcx>) {
707 fn clean(&self, cx: &DocContext<'_>) -> Generics {
708 use self::WherePredicate as WP;
709 use std::collections::BTreeMap;
711 let (gens, preds) = *self;
713 // Don't populate `cx.impl_trait_bounds` before `clean`ning `where` clauses,
714 // since `Clean for ty::Predicate` would consume them.
715 let mut impl_trait = BTreeMap::<ImplTraitParam, Vec<GenericBound>>::default();
717 // Bounds in the type_params and lifetimes fields are repeated in the
718 // predicates field (see rustc_typeck::collect::ty_generics), so remove
720 let stripped_params = gens
723 .filter_map(|param| match param.kind {
724 ty::GenericParamDefKind::Lifetime => Some(param.clean(cx)),
725 ty::GenericParamDefKind::Type { synthetic, .. } => {
726 if param.name == kw::SelfUpper {
727 assert_eq!(param.index, 0);
730 if synthetic == Some(hir::SyntheticTyParamKind::ImplTrait) {
731 impl_trait.insert(param.index.into(), vec![]);
734 Some(param.clean(cx))
736 ty::GenericParamDefKind::Const { .. } => Some(param.clean(cx)),
738 .collect::<Vec<GenericParamDef>>();
740 // param index -> [(DefId of trait, associated type name, type)]
741 let mut impl_trait_proj = FxHashMap::<u32, Vec<(DefId, String, Ty<'tcx>)>>::default();
743 let where_predicates = preds
747 let mut projection = None;
748 let param_idx = (|| {
749 match p.skip_binders() {
750 ty::PredicateAtom::Trait(pred, _constness) => {
751 if let ty::Param(param) = pred.self_ty().kind() {
752 return Some(param.index);
755 ty::PredicateAtom::TypeOutlives(ty::OutlivesPredicate(ty, _reg)) => {
756 if let ty::Param(param) = ty.kind() {
757 return Some(param.index);
760 ty::PredicateAtom::Projection(p) => {
761 if let ty::Param(param) = p.projection_ty.self_ty().kind() {
762 projection = Some(ty::Binder::bind(p));
763 return Some(param.index);
772 if let Some(param_idx) = param_idx {
773 if let Some(b) = impl_trait.get_mut(¶m_idx.into()) {
774 let p = p.clean(cx)?;
781 .filter(|b| !b.is_sized_bound(cx)),
784 let proj = projection
785 .map(|p| (p.skip_binder().projection_ty.clean(cx), p.skip_binder().ty));
786 if let Some(((_, trait_did, name), rhs)) =
787 proj.as_ref().and_then(|(lhs, rhs)| Some((lhs.projection()?, rhs)))
789 impl_trait_proj.entry(param_idx).or_default().push((
802 .collect::<Vec<_>>();
804 for (param, mut bounds) in impl_trait {
805 // Move trait bounds to the front.
806 bounds.sort_by_key(|b| if let GenericBound::TraitBound(..) = b { false } else { true });
808 if let crate::core::ImplTraitParam::ParamIndex(idx) = param {
809 if let Some(proj) = impl_trait_proj.remove(&idx) {
810 for (trait_did, name, rhs) in proj {
811 simplify::merge_bounds(cx, &mut bounds, trait_did, &name, &rhs.clean(cx));
818 cx.impl_trait_bounds.borrow_mut().insert(param, bounds);
821 // Now that `cx.impl_trait_bounds` is populated, we can process
822 // remaining predicates which could contain `impl Trait`.
823 let mut where_predicates =
824 where_predicates.into_iter().flat_map(|p| p.clean(cx)).collect::<Vec<_>>();
826 // Type parameters have a Sized bound by default unless removed with
827 // ?Sized. Scan through the predicates and mark any type parameter with
828 // a Sized bound, removing the bounds as we find them.
830 // Note that associated types also have a sized bound by default, but we
831 // don't actually know the set of associated types right here so that's
832 // handled in cleaning associated types
833 let mut sized_params = FxHashSet::default();
834 where_predicates.retain(|pred| match *pred {
835 WP::BoundPredicate { ty: Generic(ref g), ref bounds } => {
836 if bounds.iter().any(|b| b.is_sized_bound(cx)) {
837 sized_params.insert(g.clone());
846 // Run through the type parameters again and insert a ?Sized
847 // unbound for any we didn't find to be Sized.
848 for tp in &stripped_params {
849 if matches!(tp.kind, types::GenericParamDefKind::Type { .. })
850 && !sized_params.contains(&tp.name)
852 where_predicates.push(WP::BoundPredicate {
853 ty: Type::Generic(tp.name.clone()),
854 bounds: vec![GenericBound::maybe_sized(cx)],
859 // It would be nice to collect all of the bounds on a type and recombine
860 // them if possible, to avoid e.g., `where T: Foo, T: Bar, T: Sized, T: 'a`
861 // and instead see `where T: Foo + Bar + Sized + 'a`
864 params: stripped_params,
865 where_predicates: simplify::where_clauses(cx, where_predicates),
870 fn clean_fn_or_proc_macro(
871 item: &hir::Item<'_>,
872 sig: &'a hir::FnSig<'a>,
873 generics: &'a hir::Generics<'a>,
874 body_id: hir::BodyId,
878 let macro_kind = item.attrs.iter().find_map(|a| {
879 if a.has_name(sym::proc_macro) {
880 Some(MacroKind::Bang)
881 } else if a.has_name(sym::proc_macro_derive) {
882 Some(MacroKind::Derive)
883 } else if a.has_name(sym::proc_macro_attribute) {
884 Some(MacroKind::Attr)
891 if kind == MacroKind::Derive {
894 .lists(sym::proc_macro_derive)
895 .find_map(|mi| mi.ident())
896 .expect("proc-macro derives require a name")
900 let mut helpers = Vec::new();
901 for mi in item.attrs.lists(sym::proc_macro_derive) {
902 if !mi.has_name(sym::attributes) {
906 if let Some(list) = mi.meta_item_list() {
907 for inner_mi in list {
908 if let Some(ident) = inner_mi.ident() {
909 helpers.push(ident.name);
914 ProcMacroItem(ProcMacro { kind, helpers: helpers.clean(cx) })
917 let mut func = (sig, generics, body_id).clean(cx);
918 let def_id = cx.tcx.hir().local_def_id(item.hir_id).to_def_id();
919 func.header.constness =
920 if is_const_fn(cx.tcx, def_id) && is_unstable_const_fn(cx.tcx, def_id).is_none() {
921 hir::Constness::Const
923 hir::Constness::NotConst
930 impl<'a> Clean<Function> for (&'a hir::FnSig<'a>, &'a hir::Generics<'a>, hir::BodyId) {
931 fn clean(&self, cx: &DocContext<'_>) -> Function {
932 let (generics, decl) =
933 enter_impl_trait(cx, || (self.1.clean(cx), (&*self.0.decl, self.2).clean(cx)));
934 let (all_types, ret_types) = get_all_types(&generics, &decl, cx);
935 Function { decl, generics, header: self.0.header, all_types, ret_types }
939 impl<'a> Clean<Arguments> for (&'a [hir::Ty<'a>], &'a [Ident]) {
940 fn clean(&self, cx: &DocContext<'_>) -> Arguments {
947 let mut name = self.1.get(i).map(|ident| ident.to_string()).unwrap_or_default();
949 name = "_".to_string();
951 Argument { name, type_: ty.clean(cx) }
958 impl<'a> Clean<Arguments> for (&'a [hir::Ty<'a>], hir::BodyId) {
959 fn clean(&self, cx: &DocContext<'_>) -> Arguments {
960 let body = cx.tcx.hir().body(self.1);
967 .map(|(i, ty)| Argument {
968 name: name_from_pat(&body.params[i].pat),
976 impl<'a, A: Copy> Clean<FnDecl> for (&'a hir::FnDecl<'a>, A)
978 (&'a [hir::Ty<'a>], A): Clean<Arguments>,
980 fn clean(&self, cx: &DocContext<'_>) -> FnDecl {
982 inputs: (&self.0.inputs[..], self.1).clean(cx),
983 output: self.0.output.clean(cx),
984 c_variadic: self.0.c_variadic,
985 attrs: Attributes::default(),
990 impl<'tcx> Clean<FnDecl> for (DefId, ty::PolyFnSig<'tcx>) {
991 fn clean(&self, cx: &DocContext<'_>) -> FnDecl {
992 let (did, sig) = *self;
993 let mut names = if did.is_local() { &[] } else { cx.tcx.fn_arg_names(did) }.iter();
996 output: Return(sig.skip_binder().output().clean(cx)),
997 attrs: Attributes::default(),
998 c_variadic: sig.skip_binder().c_variadic,
1006 name: names.next().map_or(String::new(), |name| name.to_string()),
1014 impl Clean<FnRetTy> for hir::FnRetTy<'_> {
1015 fn clean(&self, cx: &DocContext<'_>) -> FnRetTy {
1017 Self::Return(ref typ) => Return(typ.clean(cx)),
1018 Self::DefaultReturn(..) => DefaultReturn,
1023 impl Clean<bool> for hir::IsAuto {
1024 fn clean(&self, _: &DocContext<'_>) -> bool {
1026 hir::IsAuto::Yes => true,
1027 hir::IsAuto::No => false,
1032 impl Clean<Type> for hir::TraitRef<'_> {
1033 fn clean(&self, cx: &DocContext<'_>) -> Type {
1034 resolve_type(cx, self.path.clean(cx), self.hir_ref_id)
1038 impl Clean<PolyTrait> for hir::PolyTraitRef<'_> {
1039 fn clean(&self, cx: &DocContext<'_>) -> PolyTrait {
1041 trait_: self.trait_ref.clean(cx),
1042 generic_params: self.bound_generic_params.clean(cx),
1047 impl Clean<TypeKind> for hir::def::DefKind {
1048 fn clean(&self, _: &DocContext<'_>) -> TypeKind {
1050 hir::def::DefKind::Mod => TypeKind::Module,
1051 hir::def::DefKind::Struct => TypeKind::Struct,
1052 hir::def::DefKind::Union => TypeKind::Union,
1053 hir::def::DefKind::Enum => TypeKind::Enum,
1054 hir::def::DefKind::Trait => TypeKind::Trait,
1055 hir::def::DefKind::TyAlias => TypeKind::Typedef,
1056 hir::def::DefKind::ForeignTy => TypeKind::Foreign,
1057 hir::def::DefKind::TraitAlias => TypeKind::TraitAlias,
1058 hir::def::DefKind::Fn => TypeKind::Function,
1059 hir::def::DefKind::Const => TypeKind::Const,
1060 hir::def::DefKind::Static => TypeKind::Static,
1061 hir::def::DefKind::Macro(_) => TypeKind::Macro,
1062 _ => TypeKind::Foreign,
1067 impl Clean<Item> for hir::TraitItem<'_> {
1068 fn clean(&self, cx: &DocContext<'_>) -> Item {
1069 let local_did = cx.tcx.hir().local_def_id(self.hir_id).to_def_id();
1070 cx.with_param_env(local_did, || {
1071 let inner = match self.kind {
1072 hir::TraitItemKind::Const(ref ty, default) => {
1073 AssocConstItem(ty.clean(cx), default.map(|e| print_const_expr(cx, e)))
1075 hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
1076 let mut m = (sig, &self.generics, body).clean(cx);
1077 if m.header.constness == hir::Constness::Const
1078 && is_unstable_const_fn(cx.tcx, local_did).is_some()
1080 m.header.constness = hir::Constness::NotConst;
1084 hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Required(ref names)) => {
1085 let (generics, decl) = enter_impl_trait(cx, || {
1086 (self.generics.clean(cx), (&*sig.decl, &names[..]).clean(cx))
1088 let (all_types, ret_types) = get_all_types(&generics, &decl, cx);
1090 Function { header: sig.header, decl, generics, all_types, ret_types };
1091 if t.header.constness == hir::Constness::Const
1092 && is_unstable_const_fn(cx.tcx, local_did).is_some()
1094 t.header.constness = hir::Constness::NotConst;
1098 hir::TraitItemKind::Type(ref bounds, ref default) => {
1099 AssocTypeItem(bounds.clean(cx), default.clean(cx))
1102 Item::from_def_id_and_parts(local_did, Some(self.ident.name.clean(cx)), inner, cx)
1107 impl Clean<Item> for hir::ImplItem<'_> {
1108 fn clean(&self, cx: &DocContext<'_>) -> Item {
1109 let local_did = cx.tcx.hir().local_def_id(self.hir_id).to_def_id();
1110 cx.with_param_env(local_did, || {
1111 let inner = match self.kind {
1112 hir::ImplItemKind::Const(ref ty, expr) => {
1113 AssocConstItem(ty.clean(cx), Some(print_const_expr(cx, expr)))
1115 hir::ImplItemKind::Fn(ref sig, body) => {
1116 let mut m = (sig, &self.generics, body).clean(cx);
1117 if m.header.constness == hir::Constness::Const
1118 && is_unstable_const_fn(cx.tcx, local_did).is_some()
1120 m.header.constness = hir::Constness::NotConst;
1122 MethodItem(m, Some(self.defaultness))
1124 hir::ImplItemKind::TyAlias(ref ty) => {
1125 let type_ = ty.clean(cx);
1126 let item_type = type_.def_id().and_then(|did| inline::build_ty(cx, did));
1127 TypedefItem(Typedef { type_, generics: Generics::default(), item_type }, true)
1130 Item::from_def_id_and_parts(local_did, Some(self.ident.name.clean(cx)), inner, cx)
1135 impl Clean<Item> for ty::AssocItem {
1136 fn clean(&self, cx: &DocContext<'_>) -> Item {
1137 let kind = match self.kind {
1138 ty::AssocKind::Const => {
1139 let ty = cx.tcx.type_of(self.def_id);
1140 let default = if self.defaultness.has_value() {
1141 Some(inline::print_inlined_const(cx, self.def_id))
1145 AssocConstItem(ty.clean(cx), default)
1147 ty::AssocKind::Fn => {
1149 (cx.tcx.generics_of(self.def_id), cx.tcx.explicit_predicates_of(self.def_id))
1151 let sig = cx.tcx.fn_sig(self.def_id);
1152 let mut decl = (self.def_id, sig).clean(cx);
1154 if self.fn_has_self_parameter {
1155 let self_ty = match self.container {
1156 ty::ImplContainer(def_id) => cx.tcx.type_of(def_id),
1157 ty::TraitContainer(_) => cx.tcx.types.self_param,
1159 let self_arg_ty = sig.input(0).skip_binder();
1160 if self_arg_ty == self_ty {
1161 decl.inputs.values[0].type_ = Generic(String::from("Self"));
1162 } else if let ty::Ref(_, ty, _) = *self_arg_ty.kind() {
1164 match decl.inputs.values[0].type_ {
1165 BorrowedRef { ref mut type_, .. } => {
1166 **type_ = Generic(String::from("Self"))
1168 _ => unreachable!(),
1174 let provided = match self.container {
1175 ty::ImplContainer(_) => true,
1176 ty::TraitContainer(_) => self.defaultness.has_value(),
1178 let (all_types, ret_types) = get_all_types(&generics, &decl, cx);
1180 let constness = if is_min_const_fn(cx.tcx, self.def_id) {
1181 hir::Constness::Const
1183 hir::Constness::NotConst
1185 let asyncness = cx.tcx.asyncness(self.def_id);
1186 let defaultness = match self.container {
1187 ty::ImplContainer(_) => Some(self.defaultness),
1188 ty::TraitContainer(_) => None,
1194 header: hir::FnHeader {
1195 unsafety: sig.unsafety(),
1206 TyMethodItem(Function {
1209 header: hir::FnHeader {
1210 unsafety: sig.unsafety(),
1212 constness: hir::Constness::NotConst,
1213 asyncness: hir::IsAsync::NotAsync,
1220 ty::AssocKind::Type => {
1221 let my_name = self.ident.name.clean(cx);
1223 if let ty::TraitContainer(_) = self.container {
1224 let bounds = cx.tcx.explicit_item_bounds(self.def_id);
1225 let predicates = ty::GenericPredicates { parent: None, predicates: bounds };
1226 let generics = (cx.tcx.generics_of(self.def_id), predicates).clean(cx);
1227 let mut bounds = generics
1230 .filter_map(|pred| {
1231 let (name, self_type, trait_, bounds) = match *pred {
1232 WherePredicate::BoundPredicate {
1233 ty: QPath { ref name, ref self_type, ref trait_ },
1235 } => (name, self_type, trait_, bounds),
1238 if *name != my_name {
1242 ResolvedPath { did, .. } if did == self.container.id() => {}
1246 Generic(ref s) if *s == "Self" => {}
1251 .flat_map(|i| i.iter().cloned())
1252 .collect::<Vec<_>>();
1253 // Our Sized/?Sized bound didn't get handled when creating the generics
1254 // because we didn't actually get our whole set of bounds until just now
1255 // (some of them may have come from the trait). If we do have a sized
1256 // bound, we remove it, and if we don't then we add the `?Sized` bound
1258 match bounds.iter().position(|b| b.is_sized_bound(cx)) {
1262 None => bounds.push(GenericBound::maybe_sized(cx)),
1265 let ty = if self.defaultness.has_value() {
1266 Some(cx.tcx.type_of(self.def_id))
1271 AssocTypeItem(bounds, ty.clean(cx))
1273 let type_ = cx.tcx.type_of(self.def_id).clean(cx);
1274 let item_type = type_.def_id().and_then(|did| inline::build_ty(cx, did));
1278 generics: Generics { params: Vec::new(), where_predicates: Vec::new() },
1287 Item::from_def_id_and_parts(self.def_id, Some(self.ident.name.clean(cx)), kind, cx)
1291 fn clean_qpath(hir_ty: &hir::Ty<'_>, cx: &DocContext<'_>) -> Type {
1292 use rustc_hir::GenericParamCount;
1293 let hir::Ty { hir_id, span, ref kind } = *hir_ty;
1294 let qpath = match kind {
1295 hir::TyKind::Path(qpath) => qpath,
1296 _ => unreachable!(),
1300 hir::QPath::Resolved(None, ref path) => {
1301 if let Res::Def(DefKind::TyParam, did) = path.res {
1302 if let Some(new_ty) = cx.ty_substs.borrow().get(&did).cloned() {
1305 if let Some(bounds) = cx.impl_trait_bounds.borrow_mut().remove(&did.into()) {
1306 return ImplTrait(bounds);
1310 let mut alias = None;
1311 if let Res::Def(DefKind::TyAlias, def_id) = path.res {
1312 // Substitute private type aliases
1313 if let Some(def_id) = def_id.as_local() {
1314 let hir_id = cx.tcx.hir().local_def_id_to_hir_id(def_id);
1315 if !cx.renderinfo.borrow().access_levels.is_exported(def_id.to_def_id()) {
1316 alias = Some(&cx.tcx.hir().expect_item(hir_id).kind);
1321 if let Some(&hir::ItemKind::TyAlias(ref ty, ref generics)) = alias {
1322 let provided_params = &path.segments.last().expect("segments were empty");
1323 let mut ty_substs = FxHashMap::default();
1324 let mut lt_substs = FxHashMap::default();
1325 let mut ct_substs = FxHashMap::default();
1326 let generic_args = provided_params.generic_args();
1328 let mut indices: GenericParamCount = Default::default();
1329 for param in generics.params.iter() {
1331 hir::GenericParamKind::Lifetime { .. } => {
1333 let lifetime = generic_args.args.iter().find_map(|arg| match arg {
1334 hir::GenericArg::Lifetime(lt) => {
1335 if indices.lifetimes == j {
1343 if let Some(lt) = lifetime.cloned() {
1344 let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1345 let cleaned = if !lt.is_elided() {
1348 self::types::Lifetime::elided()
1350 lt_substs.insert(lt_def_id.to_def_id(), cleaned);
1352 indices.lifetimes += 1;
1354 hir::GenericParamKind::Type { ref default, .. } => {
1355 let ty_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1357 let type_ = generic_args.args.iter().find_map(|arg| match arg {
1358 hir::GenericArg::Type(ty) => {
1359 if indices.types == j {
1367 if let Some(ty) = type_ {
1368 ty_substs.insert(ty_param_def_id.to_def_id(), ty.clean(cx));
1369 } else if let Some(default) = *default {
1371 .insert(ty_param_def_id.to_def_id(), default.clean(cx));
1375 hir::GenericParamKind::Const { .. } => {
1376 let const_param_def_id = cx.tcx.hir().local_def_id(param.hir_id);
1378 let const_ = generic_args.args.iter().find_map(|arg| match arg {
1379 hir::GenericArg::Const(ct) => {
1380 if indices.consts == j {
1388 if let Some(ct) = const_ {
1389 ct_substs.insert(const_param_def_id.to_def_id(), ct.clean(cx));
1391 // FIXME(const_generics:defaults)
1392 indices.consts += 1;
1397 return cx.enter_alias(ty_substs, lt_substs, ct_substs, || ty.clean(cx));
1399 resolve_type(cx, path.clean(cx), hir_id)
1401 hir::QPath::Resolved(Some(ref qself), ref p) => {
1402 // Try to normalize `<X as Y>::T` to a type
1403 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1404 if let Some(normalized_value) = normalize(cx, ty) {
1405 return normalized_value.clean(cx);
1408 let segments = if p.is_global() { &p.segments[1..] } else { &p.segments };
1409 let trait_segments = &segments[..segments.len() - 1];
1410 let trait_path = self::Path {
1411 global: p.is_global(),
1414 cx.tcx.associated_item(p.res.def_id()).container.id(),
1416 segments: trait_segments.clean(cx),
1419 name: p.segments.last().expect("segments were empty").ident.name.clean(cx),
1420 self_type: box qself.clean(cx),
1421 trait_: box resolve_type(cx, trait_path, hir_id),
1424 hir::QPath::TypeRelative(ref qself, ref segment) => {
1425 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1426 let res = if let ty::Projection(proj) = ty.kind() {
1427 Res::Def(DefKind::Trait, proj.trait_ref(cx.tcx).def_id)
1431 let trait_path = hir::Path { span, res, segments: &[] };
1433 name: segment.ident.name.clean(cx),
1434 self_type: box qself.clean(cx),
1435 trait_: box resolve_type(cx, trait_path.clean(cx), hir_id),
1438 hir::QPath::LangItem(..) => bug!("clean: requiring documentation of lang item"),
1442 impl Clean<Type> for hir::Ty<'_> {
1443 fn clean(&self, cx: &DocContext<'_>) -> Type {
1447 TyKind::Never => Never,
1448 TyKind::Ptr(ref m) => RawPointer(m.mutbl, box m.ty.clean(cx)),
1449 TyKind::Rptr(ref l, ref m) => {
1450 let lifetime = if l.is_elided() { None } else { Some(l.clean(cx)) };
1451 BorrowedRef { lifetime, mutability: m.mutbl, type_: box m.ty.clean(cx) }
1453 TyKind::Slice(ref ty) => Slice(box ty.clean(cx)),
1454 TyKind::Array(ref ty, ref length) => {
1455 let def_id = cx.tcx.hir().local_def_id(length.hir_id);
1456 // NOTE(min_const_generics): We can't use `const_eval_poly` for constants
1457 // as we currently do not supply the parent generics to anonymous constants
1458 // but do allow `ConstKind::Param`.
1460 // `const_eval_poly` tries to to first substitute generic parameters which
1461 // results in an ICE while manually constructing the constant and using `eval`
1462 // does nothing for `ConstKind::Param`.
1463 let ct = ty::Const::from_anon_const(cx.tcx, def_id);
1464 let param_env = cx.tcx.param_env(def_id);
1465 let length = print_const(cx, ct.eval(cx.tcx, param_env));
1466 Array(box ty.clean(cx), length)
1468 TyKind::Tup(ref tys) => Tuple(tys.clean(cx)),
1469 TyKind::OpaqueDef(item_id, _) => {
1470 let item = cx.tcx.hir().expect_item(item_id.id);
1471 if let hir::ItemKind::OpaqueTy(ref ty) = item.kind {
1472 ImplTrait(ty.bounds.clean(cx))
1477 TyKind::Path(_) => clean_qpath(&self, cx),
1478 TyKind::TraitObject(ref bounds, ref lifetime) => {
1479 match bounds[0].clean(cx).trait_ {
1480 ResolvedPath { path, param_names: None, did, is_generic } => {
1481 let mut bounds: Vec<self::GenericBound> = bounds[1..]
1484 self::GenericBound::TraitBound(
1486 hir::TraitBoundModifier::None,
1490 if !lifetime.is_elided() {
1491 bounds.push(self::GenericBound::Outlives(lifetime.clean(cx)));
1493 ResolvedPath { path, param_names: Some(bounds), did, is_generic }
1495 _ => Infer, // shouldn't happen
1498 TyKind::BareFn(ref barefn) => BareFunction(box barefn.clean(cx)),
1499 TyKind::Infer | TyKind::Err => Infer,
1500 TyKind::Typeof(..) => panic!("unimplemented type {:?}", self.kind),
1505 /// Returns `None` if the type could not be normalized
1506 #[allow(unreachable_code, unused_variables)]
1507 fn normalize(cx: &DocContext<'tcx>, ty: Ty<'_>) -> Option<Ty<'tcx>> {
1508 return None; // HACK: low-churn fix for #79459 while we wait for a trait normalization fix
1509 use crate::rustc_trait_selection::infer::TyCtxtInferExt;
1510 use crate::rustc_trait_selection::traits::query::normalize::AtExt;
1511 use rustc_middle::traits::ObligationCause;
1513 // Try to normalize `<X as Y>::T` to a type
1514 let lifted = ty.lift_to_tcx(cx.tcx).unwrap();
1515 let normalized = cx.tcx.infer_ctxt().enter(|infcx| {
1517 .at(&ObligationCause::dummy(), cx.param_env.get())
1519 .map(|resolved| infcx.resolve_vars_if_possible(resolved.value))
1522 Ok(normalized_value) => {
1523 debug!("normalized {:?} to {:?}", ty, normalized_value);
1524 Some(normalized_value)
1527 debug!("failed to normalize {:?}: {:?}", ty, err);
1533 impl<'tcx> Clean<Type> for Ty<'tcx> {
1534 fn clean(&self, cx: &DocContext<'_>) -> Type {
1535 debug!("cleaning type: {:?}", self);
1536 let ty = normalize(cx, self).unwrap_or(self);
1539 ty::Bool => Primitive(PrimitiveType::Bool),
1540 ty::Char => Primitive(PrimitiveType::Char),
1541 ty::Int(int_ty) => Primitive(int_ty.into()),
1542 ty::Uint(uint_ty) => Primitive(uint_ty.into()),
1543 ty::Float(float_ty) => Primitive(float_ty.into()),
1544 ty::Str => Primitive(PrimitiveType::Str),
1545 ty::Slice(ty) => Slice(box ty.clean(cx)),
1546 ty::Array(ty, n) => {
1547 let mut n = cx.tcx.lift(n).expect("array lift failed");
1548 n = n.eval(cx.tcx, ty::ParamEnv::reveal_all());
1549 let n = print_const(cx, n);
1550 Array(box ty.clean(cx), n)
1552 ty::RawPtr(mt) => RawPointer(mt.mutbl, box mt.ty.clean(cx)),
1553 ty::Ref(r, ty, mutbl) => {
1554 BorrowedRef { lifetime: r.clean(cx), mutability: mutbl, type_: box ty.clean(cx) }
1556 ty::FnDef(..) | ty::FnPtr(_) => {
1557 let ty = cx.tcx.lift(*self).expect("FnPtr lift failed");
1558 let sig = ty.fn_sig(cx.tcx);
1559 let def_id = DefId::local(CRATE_DEF_INDEX);
1560 BareFunction(box BareFunctionDecl {
1561 unsafety: sig.unsafety(),
1562 generic_params: Vec::new(),
1563 decl: (def_id, sig).clean(cx),
1567 ty::Adt(def, substs) => {
1569 let kind = match def.adt_kind() {
1570 AdtKind::Struct => TypeKind::Struct,
1571 AdtKind::Union => TypeKind::Union,
1572 AdtKind::Enum => TypeKind::Enum,
1574 inline::record_extern_fqn(cx, did, kind);
1575 let path = external_path(cx, cx.tcx.item_name(did), None, false, vec![], substs);
1576 ResolvedPath { path, param_names: None, did, is_generic: false }
1578 ty::Foreign(did) => {
1579 inline::record_extern_fqn(cx, did, TypeKind::Foreign);
1580 let path = external_path(
1582 cx.tcx.item_name(did),
1586 InternalSubsts::empty(),
1588 ResolvedPath { path, param_names: None, did, is_generic: false }
1590 ty::Dynamic(ref obj, ref reg) => {
1591 // HACK: pick the first `did` as the `did` of the trait object. Someone
1592 // might want to implement "native" support for marker-trait-only
1594 let mut dids = obj.principal_def_id().into_iter().chain(obj.auto_traits());
1597 .unwrap_or_else(|| panic!("found trait object `{:?}` with no traits?", self));
1598 let substs = match obj.principal() {
1599 Some(principal) => principal.skip_binder().substs,
1600 // marker traits have no substs.
1601 _ => cx.tcx.intern_substs(&[]),
1604 inline::record_extern_fqn(cx, did, TypeKind::Trait);
1606 let mut param_names = vec![];
1607 if let Some(b) = reg.clean(cx) {
1608 param_names.push(GenericBound::Outlives(b));
1611 let empty = cx.tcx.intern_substs(&[]);
1613 external_path(cx, cx.tcx.item_name(did), Some(did), false, vec![], empty);
1614 inline::record_extern_fqn(cx, did, TypeKind::Trait);
1615 let bound = GenericBound::TraitBound(
1617 trait_: ResolvedPath {
1623 generic_params: Vec::new(),
1625 hir::TraitBoundModifier::None,
1627 param_names.push(bound);
1630 let mut bindings = vec![];
1631 for pb in obj.projection_bounds() {
1632 bindings.push(TypeBinding {
1633 name: cx.tcx.associated_item(pb.item_def_id()).ident.name.clean(cx),
1634 kind: TypeBindingKind::Equality { ty: pb.skip_binder().ty.clean(cx) },
1639 external_path(cx, cx.tcx.item_name(did), Some(did), false, bindings, substs);
1640 ResolvedPath { path, param_names: Some(param_names), did, is_generic: false }
1642 ty::Tuple(ref t) => {
1643 Tuple(t.iter().map(|t| t.expect_ty()).collect::<Vec<_>>().clean(cx))
1646 ty::Projection(ref data) => data.clean(cx),
1648 ty::Param(ref p) => {
1649 if let Some(bounds) = cx.impl_trait_bounds.borrow_mut().remove(&p.index.into()) {
1652 Generic(p.name.to_string())
1656 ty::Opaque(def_id, substs) => {
1657 // Grab the "TraitA + TraitB" from `impl TraitA + TraitB`,
1658 // by looking up the bounds associated with the def_id.
1659 let substs = cx.tcx.lift(substs).expect("Opaque lift failed");
1662 .explicit_item_bounds(def_id)
1664 .map(|(bound, _)| bound.subst(cx.tcx, substs))
1665 .collect::<Vec<_>>();
1666 let mut regions = vec![];
1667 let mut has_sized = false;
1668 let mut bounds = bounds
1670 .filter_map(|bound| {
1671 // Note: The substs of opaque types can contain unbound variables,
1672 // meaning that we have to use `ignore_quantifiers_with_unbound_vars` here.
1673 let trait_ref = match bound
1674 .bound_atom_with_opt_escaping(cx.tcx)
1677 ty::PredicateAtom::Trait(tr, _constness) => {
1678 ty::Binder::bind(tr.trait_ref)
1680 ty::PredicateAtom::TypeOutlives(ty::OutlivesPredicate(_ty, reg)) => {
1681 if let Some(r) = reg.clean(cx) {
1682 regions.push(GenericBound::Outlives(r));
1689 if let Some(sized) = cx.tcx.lang_items().sized_trait() {
1690 if trait_ref.def_id() == sized {
1696 let bounds: Vec<_> = bounds
1698 .filter_map(|bound| {
1699 if let ty::PredicateAtom::Projection(proj) =
1700 bound.bound_atom_with_opt_escaping(cx.tcx).skip_binder()
1702 if proj.projection_ty.trait_ref(cx.tcx)
1703 == trait_ref.skip_binder()
1708 .associated_item(proj.projection_ty.item_def_id)
1712 kind: TypeBindingKind::Equality {
1713 ty: proj.ty.clean(cx),
1725 Some((trait_ref, &bounds[..]).clean(cx))
1727 .collect::<Vec<_>>();
1728 bounds.extend(regions);
1729 if !has_sized && !bounds.is_empty() {
1730 bounds.insert(0, GenericBound::maybe_sized(cx));
1735 ty::Closure(..) | ty::Generator(..) => Tuple(vec![]), // FIXME(pcwalton)
1737 ty::Bound(..) => panic!("Bound"),
1738 ty::Placeholder(..) => panic!("Placeholder"),
1739 ty::GeneratorWitness(..) => panic!("GeneratorWitness"),
1740 ty::Infer(..) => panic!("Infer"),
1741 ty::Error(_) => panic!("Error"),
1746 impl<'tcx> Clean<Constant> for ty::Const<'tcx> {
1747 fn clean(&self, cx: &DocContext<'_>) -> Constant {
1749 type_: self.ty.clean(cx),
1750 expr: format!("{}", self),
1757 impl Clean<Item> for hir::StructField<'_> {
1758 fn clean(&self, cx: &DocContext<'_>) -> Item {
1759 let what_rustc_thinks = Item::from_hir_id_and_parts(
1761 Some(self.ident.name),
1762 StructFieldItem(self.ty.clean(cx)),
1765 // Don't show `pub` for fields on enum variants; they are always public
1766 Item { visibility: self.vis.clean(cx), ..what_rustc_thinks }
1770 impl Clean<Item> for ty::FieldDef {
1771 fn clean(&self, cx: &DocContext<'_>) -> Item {
1772 let what_rustc_thinks = Item::from_def_id_and_parts(
1774 Some(self.ident.name.clean(cx)),
1775 StructFieldItem(cx.tcx.type_of(self.did).clean(cx)),
1778 // Don't show `pub` for fields on enum variants; they are always public
1779 Item { visibility: self.vis.clean(cx), ..what_rustc_thinks }
1783 impl Clean<Visibility> for hir::Visibility<'_> {
1784 fn clean(&self, cx: &DocContext<'_>) -> Visibility {
1786 hir::VisibilityKind::Public => Visibility::Public,
1787 hir::VisibilityKind::Inherited => Visibility::Inherited,
1788 hir::VisibilityKind::Crate(_) => {
1789 let krate = DefId::local(CRATE_DEF_INDEX);
1790 Visibility::Restricted(krate, cx.tcx.def_path(krate))
1792 hir::VisibilityKind::Restricted { ref path, .. } => {
1793 let path = path.clean(cx);
1794 let did = register_res(cx, path.res);
1795 Visibility::Restricted(did, cx.tcx.def_path(did))
1801 impl Clean<Visibility> for ty::Visibility {
1802 fn clean(&self, cx: &DocContext<'_>) -> Visibility {
1804 ty::Visibility::Public => Visibility::Public,
1805 ty::Visibility::Invisible => Visibility::Inherited,
1806 ty::Visibility::Restricted(module) => {
1807 Visibility::Restricted(module, cx.tcx.def_path(module))
1813 impl Clean<VariantStruct> for rustc_hir::VariantData<'_> {
1814 fn clean(&self, cx: &DocContext<'_>) -> VariantStruct {
1816 struct_type: doctree::struct_type_from_def(self),
1817 fields: self.fields().iter().map(|x| x.clean(cx)).collect(),
1818 fields_stripped: false,
1823 impl Clean<Item> for doctree::Variant<'_> {
1824 fn clean(&self, cx: &DocContext<'_>) -> Item {
1825 let what_rustc_thinks = Item::from_hir_id_and_parts(
1828 VariantItem(Variant { kind: self.def.clean(cx) }),
1831 // don't show `pub` for variants, which are always public
1832 Item { visibility: Inherited, ..what_rustc_thinks }
1836 impl Clean<Item> for ty::VariantDef {
1837 fn clean(&self, cx: &DocContext<'_>) -> Item {
1838 let kind = match self.ctor_kind {
1839 CtorKind::Const => VariantKind::CLike,
1840 CtorKind::Fn => VariantKind::Tuple(
1841 self.fields.iter().map(|f| cx.tcx.type_of(f.did).clean(cx)).collect(),
1843 CtorKind::Fictive => VariantKind::Struct(VariantStruct {
1844 struct_type: doctree::Plain,
1845 fields_stripped: false,
1850 let name = Some(field.ident.name.clean(cx));
1851 let kind = StructFieldItem(cx.tcx.type_of(field.did).clean(cx));
1852 let what_rustc_thinks =
1853 Item::from_def_id_and_parts(field.did, name, kind, cx);
1854 // don't show `pub` for fields, which are always public
1855 Item { visibility: Visibility::Inherited, ..what_rustc_thinks }
1860 let what_rustc_thinks = Item::from_def_id_and_parts(
1862 Some(self.ident.name.clean(cx)),
1863 VariantItem(Variant { kind }),
1866 // don't show `pub` for fields, which are always public
1867 Item { visibility: Inherited, ..what_rustc_thinks }
1871 impl Clean<VariantKind> for hir::VariantData<'_> {
1872 fn clean(&self, cx: &DocContext<'_>) -> VariantKind {
1874 hir::VariantData::Struct(..) => VariantKind::Struct(self.clean(cx)),
1875 hir::VariantData::Tuple(..) => {
1876 VariantKind::Tuple(self.fields().iter().map(|x| x.ty.clean(cx)).collect())
1878 hir::VariantData::Unit(..) => VariantKind::CLike,
1883 impl Clean<Span> for rustc_span::Span {
1884 fn clean(&self, cx: &DocContext<'_>) -> Span {
1885 if self.is_dummy() {
1886 return Span::empty();
1889 // Get the macro invocation instead of the definition,
1890 // in case the span is result of a macro expansion.
1891 // (See rust-lang/rust#39726)
1892 let span = self.source_callsite();
1894 let sm = cx.sess().source_map();
1895 let filename = sm.span_to_filename(span);
1896 let lo = sm.lookup_char_pos(span.lo());
1897 let hi = sm.lookup_char_pos(span.hi());
1902 locol: lo.col.to_usize(),
1904 hicol: hi.col.to_usize(),
1910 impl Clean<Path> for hir::Path<'_> {
1911 fn clean(&self, cx: &DocContext<'_>) -> Path {
1913 global: self.is_global(),
1915 segments: if self.is_global() { &self.segments[1..] } else { &self.segments }.clean(cx),
1920 impl Clean<GenericArgs> for hir::GenericArgs<'_> {
1921 fn clean(&self, cx: &DocContext<'_>) -> GenericArgs {
1922 if self.parenthesized {
1923 let output = self.bindings[0].ty().clean(cx);
1924 GenericArgs::Parenthesized {
1925 inputs: self.inputs().clean(cx),
1926 output: if output != Type::Tuple(Vec::new()) { Some(output) } else { None },
1929 GenericArgs::AngleBracketed {
1933 .map(|arg| match arg {
1934 hir::GenericArg::Lifetime(lt) if !lt.is_elided() => {
1935 GenericArg::Lifetime(lt.clean(cx))
1937 hir::GenericArg::Lifetime(_) => GenericArg::Lifetime(Lifetime::elided()),
1938 hir::GenericArg::Type(ty) => GenericArg::Type(ty.clean(cx)),
1939 hir::GenericArg::Const(ct) => GenericArg::Const(ct.clean(cx)),
1942 bindings: self.bindings.clean(cx),
1948 impl Clean<PathSegment> for hir::PathSegment<'_> {
1949 fn clean(&self, cx: &DocContext<'_>) -> PathSegment {
1950 PathSegment { name: self.ident.name.clean(cx), args: self.generic_args().clean(cx) }
1954 impl Clean<String> for Ident {
1956 fn clean(&self, cx: &DocContext<'_>) -> String {
1961 impl Clean<String> for Symbol {
1963 fn clean(&self, _: &DocContext<'_>) -> String {
1968 impl Clean<BareFunctionDecl> for hir::BareFnTy<'_> {
1969 fn clean(&self, cx: &DocContext<'_>) -> BareFunctionDecl {
1970 let (generic_params, decl) = enter_impl_trait(cx, || {
1971 (self.generic_params.clean(cx), (&*self.decl, &self.param_names[..]).clean(cx))
1973 BareFunctionDecl { unsafety: self.unsafety, abi: self.abi, decl, generic_params }
1977 impl Clean<Vec<Item>> for (&hir::Item<'_>, Option<Ident>) {
1978 fn clean(&self, cx: &DocContext<'_>) -> Vec<Item> {
1981 let (item, renamed) = self;
1982 let def_id = cx.tcx.hir().local_def_id(item.hir_id).to_def_id();
1983 let mut name = match renamed {
1984 Some(ident) => ident.name,
1985 None => cx.tcx.hir().name(item.hir_id),
1987 cx.with_param_env(def_id, || {
1988 let kind = match item.kind {
1989 ItemKind::Static(ty, mutability, body_id) => StaticItem(Static {
1990 type_: ty.clean(cx),
1992 expr: print_const_expr(cx, body_id),
1994 ItemKind::Const(ty, body_id) => ConstantItem(Constant {
1995 type_: ty.clean(cx),
1996 expr: print_const_expr(cx, body_id),
1997 value: print_evaluated_const(cx, def_id),
1998 is_literal: is_literal_expr(cx, body_id.hir_id),
2000 ItemKind::OpaqueTy(ref ty) => OpaqueTyItem(OpaqueTy {
2001 bounds: ty.bounds.clean(cx),
2002 generics: ty.generics.clean(cx),
2004 ItemKind::TyAlias(ty, ref generics) => {
2005 let rustdoc_ty = ty.clean(cx);
2006 let item_type = rustdoc_ty.def_id().and_then(|did| inline::build_ty(cx, did));
2008 Typedef { type_: rustdoc_ty, generics: generics.clean(cx), item_type },
2012 ItemKind::Enum(ref def, ref generics) => EnumItem(Enum {
2013 variants: def.variants.iter().map(|v| v.clean(cx)).collect(),
2014 generics: generics.clean(cx),
2015 variants_stripped: false,
2017 ItemKind::TraitAlias(ref generics, bounds) => TraitAliasItem(TraitAlias {
2018 generics: generics.clean(cx),
2019 bounds: bounds.clean(cx),
2021 ItemKind::Union(ref variant_data, ref generics) => UnionItem(Union {
2022 struct_type: doctree::struct_type_from_def(&variant_data),
2023 generics: generics.clean(cx),
2024 fields: variant_data.fields().clean(cx),
2025 fields_stripped: false,
2027 ItemKind::Struct(ref variant_data, ref generics) => StructItem(Struct {
2028 struct_type: doctree::struct_type_from_def(&variant_data),
2029 generics: generics.clean(cx),
2030 fields: variant_data.fields().clean(cx),
2031 fields_stripped: false,
2033 ItemKind::Impl { .. } => return clean_impl(item, cx),
2034 // proc macros can have a name set by attributes
2035 ItemKind::Fn(ref sig, ref generics, body_id) => {
2036 clean_fn_or_proc_macro(item, sig, generics, body_id, &mut name, cx)
2038 hir::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref item_ids) => {
2039 let items = item_ids
2041 .map(|ti| cx.tcx.hir().trait_item(ti.id).clean(cx))
2043 let attrs = item.attrs.clean(cx);
2044 let is_spotlight = attrs.has_doc_flag(sym::spotlight);
2048 generics: generics.clean(cx),
2049 bounds: bounds.clean(cx),
2051 is_auto: is_auto.clean(cx),
2054 ItemKind::ExternCrate(orig_name) => {
2055 return clean_extern_crate(item, name, orig_name, cx);
2057 _ => unreachable!("not yet converted"),
2060 vec![Item::from_def_id_and_parts(def_id, Some(name.clean(cx)), kind, cx)]
2065 impl Clean<Item> for hir::Variant<'_> {
2066 fn clean(&self, cx: &DocContext<'_>) -> Item {
2067 let kind = VariantItem(Variant { kind: self.data.clean(cx) });
2068 let what_rustc_thinks =
2069 Item::from_hir_id_and_parts(self.id, Some(self.ident.name), kind, cx);
2070 // don't show `pub` for variants, which are always public
2071 Item { visibility: Inherited, ..what_rustc_thinks }
2075 impl Clean<ImplPolarity> for ty::ImplPolarity {
2076 fn clean(&self, _: &DocContext<'_>) -> ImplPolarity {
2078 &ty::ImplPolarity::Positive |
2079 // FIXME: do we want to do something else here?
2080 &ty::ImplPolarity::Reservation => ImplPolarity::Positive,
2081 &ty::ImplPolarity::Negative => ImplPolarity::Negative,
2086 fn clean_impl(impl_: &hir::Item<'_>, cx: &DocContext<'_>) -> Vec<Item> {
2087 let mut ret = Vec::new();
2088 let (trait_, items, for_, unsafety, generics) = match &impl_.kind {
2089 hir::ItemKind::Impl { of_trait, items, self_ty, unsafety, generics, .. } => {
2090 (of_trait, items, self_ty, *unsafety, generics)
2092 _ => unreachable!(),
2094 let trait_ = trait_.clean(cx);
2095 let items = items.iter().map(|ii| cx.tcx.hir().impl_item(ii.id).clean(cx)).collect::<Vec<_>>();
2096 let def_id = cx.tcx.hir().local_def_id(impl_.hir_id);
2098 // If this impl block is an implementation of the Deref trait, then we
2099 // need to try inlining the target's inherent impl blocks as well.
2100 if trait_.def_id() == cx.tcx.lang_items().deref_trait() {
2101 build_deref_target_impls(cx, &items, &mut ret);
2104 let provided: FxHashSet<String> = trait_
2106 .map(|did| cx.tcx.provided_trait_methods(did).map(|meth| meth.ident.to_string()).collect())
2107 .unwrap_or_default();
2109 let for_ = for_.clean(cx);
2110 let type_alias = for_.def_id().and_then(|did| match cx.tcx.def_kind(did) {
2111 DefKind::TyAlias => Some(cx.tcx.type_of(did).clean(cx)),
2114 let make_item = |trait_: Option<Type>, for_: Type, items: Vec<Item>| {
2115 let kind = ImplItem(Impl {
2117 generics: generics.clean(cx),
2118 provided_trait_methods: provided.clone(),
2122 polarity: Some(cx.tcx.impl_polarity(def_id).clean(cx)),
2126 Item::from_hir_id_and_parts(impl_.hir_id, None, kind, cx)
2128 if let Some(type_alias) = type_alias {
2129 ret.push(make_item(trait_.clone(), type_alias, items.clone()));
2131 ret.push(make_item(trait_, for_, items));
2135 fn clean_extern_crate(
2136 krate: &hir::Item<'_>,
2138 orig_name: Option<Symbol>,
2139 cx: &DocContext<'_>,
2141 // this is the ID of the `extern crate` statement
2142 let def_id = cx.tcx.hir().local_def_id(krate.hir_id);
2143 let cnum = cx.tcx.extern_mod_stmt_cnum(def_id).unwrap_or(LOCAL_CRATE);
2144 // this is the ID of the crate itself
2145 let crate_def_id = DefId { krate: cnum, index: CRATE_DEF_INDEX };
2146 let please_inline = krate.vis.node.is_pub()
2147 && krate.attrs.iter().any(|a| {
2148 a.has_name(sym::doc)
2149 && match a.meta_item_list() {
2150 Some(l) => attr::list_contains_name(&l, sym::inline),
2156 let mut visited = FxHashSet::default();
2158 let res = Res::Def(DefKind::Mod, crate_def_id);
2160 if let Some(items) = inline::try_inline(
2162 cx.tcx.parent_module(krate.hir_id).to_def_id(),
2171 let path = orig_name.map(|x| x.to_string());
2172 // FIXME: using `from_def_id_and_kind` breaks `rustdoc/masked` for some reason
2175 attrs: krate.attrs.clean(cx),
2176 source: krate.span.clean(cx),
2177 def_id: crate_def_id,
2178 visibility: krate.vis.clean(cx),
2181 kind: ExternCrateItem(name.clean(cx), path),
2185 impl Clean<Vec<Item>> for doctree::Import<'_> {
2186 fn clean(&self, cx: &DocContext<'_>) -> Vec<Item> {
2187 // We need this comparison because some imports (for std types for example)
2188 // are "inserted" as well but directly by the compiler and they should not be
2189 // taken into account.
2190 if self.span.ctxt().outer_expn_data().kind == ExpnKind::AstPass(AstPass::StdImports) {
2194 // We consider inlining the documentation of `pub use` statements, but we
2195 // forcefully don't inline if this is not public or if the
2196 // #[doc(no_inline)] attribute is present.
2197 // Don't inline doc(hidden) imports so they can be stripped at a later stage.
2198 let mut denied = !self.vis.node.is_pub()
2199 || self.attrs.iter().any(|a| {
2200 a.has_name(sym::doc)
2201 && match a.meta_item_list() {
2203 attr::list_contains_name(&l, sym::no_inline)
2204 || attr::list_contains_name(&l, sym::hidden)
2209 // Also check whether imports were asked to be inlined, in case we're trying to re-export a
2210 // crate in Rust 2018+
2211 let please_inline = self.attrs.lists(sym::doc).has_word(sym::inline);
2212 let path = self.path.clean(cx);
2213 let inner = if self.glob {
2215 let mut visited = FxHashSet::default();
2216 if let Some(items) = inline::try_inline_glob(cx, path.res, &mut visited) {
2220 Import::new_glob(resolve_use_source(cx, path), true)
2222 let name = self.name;
2224 if let Res::Def(DefKind::Mod, did) = path.res {
2225 if !did.is_local() && did.index == CRATE_DEF_INDEX {
2226 // if we're `pub use`ing an extern crate root, don't inline it unless we
2227 // were specifically asked for it
2233 let mut visited = FxHashSet::default();
2235 if let Some(mut items) = inline::try_inline(
2237 cx.tcx.parent_module(self.id).to_def_id(),
2245 attrs: self.attrs.clean(cx),
2246 source: self.span.clean(cx),
2247 def_id: cx.tcx.hir().local_def_id(self.id).to_def_id(),
2248 visibility: self.vis.clean(cx),
2251 kind: ImportItem(Import::new_simple(
2252 self.name.clean(cx),
2253 resolve_use_source(cx, path),
2260 Import::new_simple(name.clean(cx), resolve_use_source(cx, path), true)
2265 attrs: self.attrs.clean(cx),
2266 source: self.span.clean(cx),
2267 def_id: DefId::local(CRATE_DEF_INDEX),
2268 visibility: self.vis.clean(cx),
2271 kind: ImportItem(inner),
2276 impl Clean<Item> for (&hir::ForeignItem<'_>, Option<Ident>) {
2277 fn clean(&self, cx: &DocContext<'_>) -> Item {
2278 let (item, renamed) = self;
2279 cx.with_param_env(cx.tcx.hir().local_def_id(item.hir_id).to_def_id(), || {
2280 let kind = match item.kind {
2281 hir::ForeignItemKind::Fn(ref decl, ref names, ref generics) => {
2282 let abi = cx.tcx.hir().get_foreign_abi(item.hir_id);
2283 let (generics, decl) = enter_impl_trait(cx, || {
2284 (generics.clean(cx), (&**decl, &names[..]).clean(cx))
2286 let (all_types, ret_types) = get_all_types(&generics, &decl, cx);
2287 ForeignFunctionItem(Function {
2290 header: hir::FnHeader {
2291 unsafety: hir::Unsafety::Unsafe,
2293 constness: hir::Constness::NotConst,
2294 asyncness: hir::IsAsync::NotAsync,
2300 hir::ForeignItemKind::Static(ref ty, mutability) => ForeignStaticItem(Static {
2301 type_: ty.clean(cx),
2303 expr: String::new(),
2305 hir::ForeignItemKind::Type => ForeignTypeItem,
2308 Item::from_hir_id_and_parts(
2310 Some(renamed.unwrap_or(item.ident).name),
2318 impl Clean<Item> for doctree::Macro {
2319 fn clean(&self, cx: &DocContext<'_>) -> Item {
2320 Item::from_def_id_and_parts(
2322 Some(self.name.clean(cx)),
2325 "macro_rules! {} {{\n{}}}",
2329 .map(|span| { format!(" {} => {{ ... }};\n", span.to_src(cx)) })
2330 .collect::<String>()
2332 imported_from: self.imported_from.clean(cx),
2339 impl Clean<Deprecation> for attr::Deprecation {
2340 fn clean(&self, _: &DocContext<'_>) -> Deprecation {
2342 since: self.since.map(|s| s.to_string()).filter(|s| !s.is_empty()),
2343 note: self.note.map(|n| n.to_string()).filter(|n| !n.is_empty()),
2344 is_since_rustc_version: self.is_since_rustc_version,
2349 impl Clean<TypeBinding> for hir::TypeBinding<'_> {
2350 fn clean(&self, cx: &DocContext<'_>) -> TypeBinding {
2351 TypeBinding { name: self.ident.name.clean(cx), kind: self.kind.clean(cx) }
2355 impl Clean<TypeBindingKind> for hir::TypeBindingKind<'_> {
2356 fn clean(&self, cx: &DocContext<'_>) -> TypeBindingKind {
2358 hir::TypeBindingKind::Equality { ref ty } => {
2359 TypeBindingKind::Equality { ty: ty.clean(cx) }
2361 hir::TypeBindingKind::Constraint { ref bounds } => {
2362 TypeBindingKind::Constraint { bounds: bounds.iter().map(|b| b.clean(cx)).collect() }
2369 TraitBound(Vec<PathSegment>, Vec<SimpleBound>, Vec<GenericParamDef>, hir::TraitBoundModifier),
2373 impl From<GenericBound> for SimpleBound {
2374 fn from(bound: GenericBound) -> Self {
2375 match bound.clone() {
2376 GenericBound::Outlives(l) => SimpleBound::Outlives(l),
2377 GenericBound::TraitBound(t, mod_) => match t.trait_ {
2378 Type::ResolvedPath { path, param_names, .. } => SimpleBound::TraitBound(
2380 param_names.map_or_else(Vec::new, |v| {
2381 v.iter().map(|p| SimpleBound::from(p.clone())).collect()
2386 _ => panic!("Unexpected bound {:?}", bound),