mdwright-document 0.1.2

Recognised Markdown document facts with stable source coordinates
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

use std::fmt;

/// Markdown source could not be parsed safely.
///
/// `CommonMark` accepts every byte string after mdwright's source
/// canonicalisation, but the parser implementation can still fail on
/// malformed edge cases. `ParseError` keeps that dependency failure at
/// the document boundary instead of exposing parser internals.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ParseError {
    input_len: usize,
}

impl ParseError {
    pub(crate) fn parser_panic(input_len: usize) -> Self {
        Self { input_len }
    }

    /// Length in bytes of the canonical parser input.
    #[must_use]
    pub fn input_len(&self) -> usize {
        self.input_len
    }
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Markdown parser failed while reading {} byte(s)", self.input_len)
    }
}

impl std::error::Error for ParseError {}