mdbook-rustdoc-links 2.0.0

Link to Rust API docs by name in mdBook
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use std::{fmt::Debug, hash::Hash};

use mdbookkit::diagnostics::{Diagnostics, ReportBuilder};

use crate::link::diagnostic::LinkDiagnostic;

use super::Pages;

impl<'a, K: Eq + Hash> Pages<'a, K> {
    pub fn diagnostics(&self) -> Vec<PageDiagnostics<'a, K>>
    where
        K: Clone,
    {
        self.pages
            .iter()
            .map(|(name, page)| {
                let issues = page.links.iter().map(|link| link.diagnostic()).collect();
                Diagnostics::new(page.source, name.clone(), issues)
            })
            .collect()
    }

    pub fn reporter(&self) -> PageReporter<'a, K>
    where
        K: Clone + Debug,
    {
        ReportBuilder::new(self.diagnostics(), |name| format!("{name:?}"))
    }
}

type PageDiagnostics<'a, K> = Diagnostics<'a, K, LinkDiagnostic>;

type PageReporter<'a, K> = ReportBuilder<'a, K, LinkDiagnostic, fn(&K) -> String>;