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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use std::fmt;

use miette::LabeledSpan;
use tracing::Level;

use mdbookkit::diagnostics::{Issue, IssueItem};

use super::{Link, LinkState};

pub struct LinkDiagnostic {
    pub status: LinkStatus,
    pub label: LabeledSpan,
}

#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum LinkStatus {
    Unresolved = 1,
    Ok,
    #[default]
    Debug,
}

impl IssueItem for LinkDiagnostic {
    type Kind = LinkStatus;

    fn issue(&self) -> Self::Kind {
        self.status
    }

    fn label(&self) -> LabeledSpan {
        self.label.clone()
    }
}

impl Issue for LinkStatus {
    fn level(&self) -> Level {
        match self {
            Self::Unresolved => Level::WARN,
            Self::Debug => Level::TRACE,
            Self::Ok => Level::DEBUG,
        }
    }

    fn title(&self) -> impl fmt::Display {
        match self {
            Self::Unresolved => "item could not be resolved",
            Self::Ok => "link resolved",
            Self::Debug => "debug info",
        }
    }
}

impl Link<'_> {
    pub fn diagnostic(&self) -> LinkDiagnostic {
        let status = match self.state {
            LinkState::Unparsed => LinkStatus::Debug,
            LinkState::Pending(_) => LinkStatus::Unresolved,
            LinkState::Resolved(_) => LinkStatus::Ok,
        };
        let label = match &self.state {
            LinkState::Unparsed => Some(self.url.as_ref().into()),
            LinkState::Pending(item) => Some(format!("could not obtain a link to {:?}", item.name)),
            LinkState::Resolved(links) => Some(format!("{}", links.url())),
        };
        let label = LabeledSpan::new_with_span(label, self.span.clone());
        LinkDiagnostic { status, label }
    }
}