rustdoc/
fold.rs

Help
1use std::mem;
2
3use crate::clean::*;
4
5pub(crate) fn strip_item(mut item: Item) -> Item {
6    if !matches!(item.inner.kind, StrippedItem(..)) {
7        item.inner.kind = StrippedItem(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            StrippedItem(..) => unreachable!(),
21            ModuleItem(i) => ModuleItem(self.fold_mod(i)),
22            StructItem(mut i) => {
23                i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
24                StructItem(i)
25            }
26            UnionItem(mut i) => {
27                i.fields = i.fields.into_iter().filter_map(|x| self.fold_item(x)).collect();
28                UnionItem(i)
29            }
30            EnumItem(mut i) => {
31                i.variants = i.variants.into_iter().filter_map(|x| self.fold_item(x)).collect();
32                EnumItem(i)
33            }
34            TraitItem(mut i) => {
35                i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
36                TraitItem(i)
37            }
38            ImplItem(mut i) => {
39                i.items = i.items.into_iter().filter_map(|x| self.fold_item(x)).collect();
40                ImplItem(i)
41            }
42            VariantItem(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                VariantItem(Variant { kind, discriminant })
56            }
57            TypeAliasItem(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                TypeAliasItem(typealias)
78            }
79            ExternCrateItem { src: _ }
80            | ImportItem(_)
81            | FunctionItem(_)
82            | StaticItem(_)
83            | ConstantItem(..)
84            | TraitAliasItem(_)
85            | RequiredMethodItem(_)
86            | MethodItem(_, _)
87            | StructFieldItem(_)
88            | ForeignFunctionItem(..)
89            | ForeignStaticItem(..)
90            | ForeignTypeItem
91            | MacroItem(_)
92            | ProcMacroItem(_)
93            | PrimitiveItem(_)
94            | RequiredAssocConstItem(..)
95            | ProvidedAssocConstItem(..)
96            | ImplAssocConstItem(..)
97            | RequiredAssocTypeItem(..)
98            | AssocTypeItem(..)
99            | KeywordItem => kind,
100        }
101    }
102
103    /// don't override!
104    fn fold_item_recur(&mut self, mut item: Item) -> Item {
105        item.inner.kind = match item.inner.kind {
106            StrippedItem(box i) => StrippedItem(Box::new(self.fold_inner_recur(i))),
107            _ => self.fold_inner_recur(item.inner.kind),
108        };
109        item
110    }
111
112    fn fold_mod(&mut self, m: Module) -> Module {
113        Module {
114            span: m.span,
115            items: m.items.into_iter().filter_map(|i| self.fold_item(i)).collect(),
116        }
117    }
118
119    fn fold_crate(&mut self, mut c: Crate) -> Crate {
120        c.module = self.fold_item(c.module).unwrap();
121
122        for trait_ in c.external_traits.values_mut() {
123            trait_.items = mem::take(&mut trait_.items)
124                .into_iter()
125                .filter_map(|i| self.fold_item(i))
126                .collect();
127        }
128
129        c
130    }
131}
rustdoc/fold.rs

rustdoc/
fold.rs
