wikrs 0.2.0

Fast, honest wikitext extraction and parsing in Rust
Documentation 
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

//! Diagnostics (DESIGN.md §7). The engine's honesty mechanism: when it meets a
//! construct outside the declared support range, it emits an `Unsupported`
//! diagnostic with the original source span — instead of silently producing
//! something plausible but wrong.

use std::ops::Range;

/// How bad a diagnostic is — and how honest we're being about why.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Severity {
    /// A genuine error inside the supported range.
    Error,
    /// Recoverable oddity; processing continued (possibly degraded).
    Warning,
    /// A construct we deliberately do not handle yet — reported, not guessed.
    Unsupported,
}

/// One diagnostic, locatable back to the source by `span` (byte range).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Diagnostic {
    /// How severe (and how deliberate) the condition is.
    pub severity: Severity,
    /// Stable machine code, e.g. `"U-TEMPLATE"`.
    pub code: &'static str,
    /// Byte range of the offending construct in the input wikitext.
    pub span: Range<usize>,
    /// Human-readable explanation.
    pub message: String,
}

impl Diagnostic {
    /// A construct outside the declared support range — reported, not guessed.
    pub fn unsupported(code: &'static str, span: Range<usize>, message: impl Into<String>) -> Self {
        Diagnostic {
            severity: Severity::Unsupported,
            code,
            span,
            message: message.into(),
        }
    }

    /// A recoverable loss: content was dropped but processing continued (e.g. a
    /// template we don't expand) — honest about *what* was lost.
    pub fn warning(code: &'static str, span: Range<usize>, message: impl Into<String>) -> Self {
        Diagnostic {
            severity: Severity::Warning,
            code,
            span,
            message: message.into(),
        }
    }
}