rustdoc/
fold.rs

1use std::mem;
2
3use crate::clean::*;
4
5pub(crate) fn strip_item(mut item: Item) -> Item {
6    if !matches!(item.inner.kind, ItemKind::Stripped(..)) {
7        item.inner.kind = ItemKind::Stripped(Box::new(item.inner.kind));
8    }
9    item
10}
11
12pub(crate) trait DocFolder: Sized {
13    fn fold_item(&mut self, item: Item) -> Option<Item> {
14        Some(self.fold_item_recur(item))
15    }
16
17    /// don't override!
18    fn fold_inner_recur(&mut self, kind: ItemKind) -> ItemKind {
19        match kind {
20            ItemKind::Stripped(..) => unreachable!(),
21            ItemKind::Module(i) => ItemKind::Module(self.fold_mod(i)),
22            ItemKind::Struct(mut i) => {
23                i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
24                ItemKind::Struct(i)
25            }
26            ItemKind::Union(mut i) => {
27                i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
28                ItemKind::Union(i)
29            }
30            ItemKind::Enum(mut i) => {
31                i.variants = i.variants.into_iter().filter_map(|x| self.fold_item(x)).collect();
32                ItemKind::Enum(i)
33            }
34            ItemKind::Trait(mut i) => {
35                i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
36                ItemKind::Trait(i)
37            }
38            ItemKind::Impl(mut i) => {
39                i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
40                ItemKind::Impl(i)
41            }
42            ItemKind::Variant(Variant { kind, discriminant }) => {
43                let kind = match kind {
44                    VariantKind::Struct(mut j) => {
45                        j.fields = j.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
46                        VariantKind::Struct(j)
47                    }
48                    VariantKind::Tuple(fields) => {
49                        let fields = fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
50                        VariantKind::Tuple(fields)
51                    }
52                    VariantKind::CLike => VariantKind::CLike,
53                };
54
55                ItemKind::Variant(Variant { kind, discriminant })
56            }
57            ItemKind::TypeAlias(mut typealias) => {
58                typealias.inner_type = typealias.inner_type.map(|inner_type| match inner_type {
59                    TypeAliasInnerType::Enum { variants, is_non_exhaustive } => {
60                        let variants = variants
61                            .into_iter_enumerated()
62                            .filter_map(|(_, x)| self.fold_item(x))
63                            .collect();
64
65                        TypeAliasInnerType::Enum { variants, is_non_exhaustive }
66                    }
67                    TypeAliasInnerType::Union { fields } => {
68                        let fields = fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
69                        TypeAliasInnerType::Union { fields }
70                    }
71                    TypeAliasInnerType::Struct { ctor_kind, fields } => {
72                        let fields = fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
73                        TypeAliasInnerType::Struct { ctor_kind, fields }
74                    }
75                });
76
77                ItemKind::TypeAlias(typealias)
78            }
79            ItemKind::ExternCrate { src: _ }
80            | ItemKind::Import(_)
81            | ItemKind::Function(_)
82            | ItemKind::Static(_)
83            | ItemKind::Constant(..)
84            | ItemKind::TraitAlias(_)
85            | ItemKind::AssocFunction(..)
86            | ItemKind::StructField(_)
87            | ItemKind::ForeignFunction(..)
88            | ItemKind::ForeignStatic(..)
89            | ItemKind::ForeignType
90            | ItemKind::DeclMacro(..)
91            | ItemKind::ProcMacro(_)
92            | ItemKind::PrimitiveType(_)
93            | ItemKind::AssocConstant(..)
94            | ItemKind::AssocType(..)
95            | ItemKind::Keyword
96            | ItemKind::Attribute
97            | ItemKind::PlaceholderImpl => kind,
98        }
99    }
100
101    /// don't override!
102    fn fold_item_recur(&mut self, mut item: Item) -> Item {
103        item.inner.kind = match item.inner.kind {
104            ItemKind::Stripped(i) => ItemKind::Stripped(Box::new(self.fold_inner_recur(*i))),
105            _ => self.fold_inner_recur(item.inner.kind),
106        };
107        item
108    }
109
110    fn fold_mod(&mut self, m: Module) -> Module {
111        Module {
112            span: m.span,
113            items: m.items.into_iter().filter_map(|i| self.fold_item(i)).collect(),
114        }
115    }
116
117    fn fold_crate(&mut self, mut c: Crate) -> Crate {
118        c.module = self.fold_item(c.module).unwrap();
119
120        for trait_ in c.external_traits.values_mut() {
121            trait_.items = mem::take(&mut trait_.items)
122                .into_iter()
123                .filter_map(|i| self.fold_item(i))
124                .collect();
125        }
126
127        c
128    }
129}
rustdoc/fold.rs

rustdoc/
fold.rs
