rustdoc/passes/
mod.rs

Help
1//! Contains information about "passes", used to modify crate information during the documentation
2//! process.
3
4use self::Condition::*;
5use crate::clean;
6use crate::core::DocContext;
7
8mod stripper;
9pub(crate) use stripper::*;
10
11mod strip_aliased_non_local;
12pub(crate) use self::strip_aliased_non_local::STRIP_ALIASED_NON_LOCAL;
13
14mod strip_hidden;
15pub(crate) use self::strip_hidden::STRIP_HIDDEN;
16
17mod strip_private;
18pub(crate) use self::strip_private::STRIP_PRIVATE;
19
20mod strip_priv_imports;
21pub(crate) use self::strip_priv_imports::STRIP_PRIV_IMPORTS;
22
23mod propagate_doc_cfg;
24pub(crate) use self::propagate_doc_cfg::PROPAGATE_DOC_CFG;
25
26mod propagate_stability;
27pub(crate) use self::propagate_stability::PROPAGATE_STABILITY;
28
29pub(crate) mod collect_intra_doc_links;
30pub(crate) use self::collect_intra_doc_links::COLLECT_INTRA_DOC_LINKS;
31
32mod check_doc_test_visibility;
33pub(crate) use self::check_doc_test_visibility::CHECK_DOC_TEST_VISIBILITY;
34
35mod collect_trait_impls;
36pub(crate) use self::collect_trait_impls::COLLECT_TRAIT_IMPLS;
37
38mod calculate_doc_coverage;
39pub(crate) use self::calculate_doc_coverage::CALCULATE_DOC_COVERAGE;
40
41mod lint;
42pub(crate) use self::lint::RUN_LINTS;
43
44/// A single pass over the cleaned documentation.
45///
46/// Runs in the compiler context, so it has access to types and traits and the like.
47#[derive(Copy, Clone)]
48pub(crate) struct Pass {
49    pub(crate) name: &'static str,
50    pub(crate) run: Option<fn(clean::Crate, &mut DocContext<'_>) -> clean::Crate>,
51    pub(crate) description: &'static str,
52}
53
54/// In a list of passes, a pass that may or may not need to be run depending on options.
55#[derive(Copy, Clone)]
56pub(crate) struct ConditionalPass {
57    pub(crate) pass: Pass,
58    pub(crate) condition: Condition,
59}
60
61/// How to decide whether to run a conditional pass.
62#[derive(Copy, Clone)]
63pub(crate) enum Condition {
64    Always,
65    /// When `--document-private-items` is passed.
66    WhenDocumentPrivate,
67    /// When `--document-private-items` is not passed.
68    WhenNotDocumentPrivate,
69    /// When `--document-hidden-items` is not passed.
70    WhenNotDocumentHidden,
71}
72
73/// The full list of passes.
74pub(crate) const PASSES: &[Pass] = &[
75    CHECK_DOC_TEST_VISIBILITY,
76    STRIP_ALIASED_NON_LOCAL,
77    STRIP_HIDDEN,
78    STRIP_PRIVATE,
79    STRIP_PRIV_IMPORTS,
80    PROPAGATE_DOC_CFG,
81    PROPAGATE_STABILITY,
82    COLLECT_INTRA_DOC_LINKS,
83    COLLECT_TRAIT_IMPLS,
84    CALCULATE_DOC_COVERAGE,
85    RUN_LINTS,
86];
87
88/// The list of passes run by default.
89pub(crate) const DEFAULT_PASSES: &[ConditionalPass] = &[
90    ConditionalPass::always(COLLECT_TRAIT_IMPLS),
91    ConditionalPass::always(CHECK_DOC_TEST_VISIBILITY),
92    ConditionalPass::always(STRIP_ALIASED_NON_LOCAL),
93    ConditionalPass::new(STRIP_HIDDEN, WhenNotDocumentHidden),
94    ConditionalPass::new(STRIP_PRIVATE, WhenNotDocumentPrivate),
95    ConditionalPass::new(STRIP_PRIV_IMPORTS, WhenDocumentPrivate),
96    ConditionalPass::always(COLLECT_INTRA_DOC_LINKS),
97    ConditionalPass::always(PROPAGATE_DOC_CFG),
98    ConditionalPass::always(PROPAGATE_STABILITY),
99    ConditionalPass::always(RUN_LINTS),
100];
101
102/// The list of default passes run when `--doc-coverage` is passed to rustdoc.
103pub(crate) const COVERAGE_PASSES: &[ConditionalPass] = &[
104    ConditionalPass::new(STRIP_HIDDEN, WhenNotDocumentHidden),
105    ConditionalPass::new(STRIP_PRIVATE, WhenNotDocumentPrivate),
106    ConditionalPass::always(CALCULATE_DOC_COVERAGE),
107];
108
109impl ConditionalPass {
110    pub(crate) const fn always(pass: Pass) -> Self {
111        Self::new(pass, Always)
112    }
113
114    pub(crate) const fn new(pass: Pass, condition: Condition) -> Self {
115        ConditionalPass { pass, condition }
116    }
117}
118
119/// Returns the given default set of passes.
120pub(crate) fn defaults(show_coverage: bool) -> &'static [ConditionalPass] {
121    if show_coverage { COVERAGE_PASSES } else { DEFAULT_PASSES }
122}
rustdoc/passes/mod.rs

rustdoc/passes/
mod.rs
