simdxml 0.2.1

SIMD-accelerated XML parser with full XPath 1.0 support
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
54

//! Error types for XML parsing, XPath evaluation, and index persistence.

use thiserror::Error;

/// All errors produced by simdxml.
#[derive(Debug, Error)]
pub enum SimdXmlError {
    /// A structural XML parse error at a specific byte offset.
    /// Returned when the parser encounters malformed markup.
    #[error("XML parse error at byte {offset}: {message}")]
    ParseError { offset: usize, message: String },

    /// The XPath expression string could not be parsed.
    /// Contains details about the syntax error.
    #[error("XPath parse error: {0}")]
    XPathParseError(String),

    /// An error occurred during XPath evaluation (e.g., type mismatch,
    /// unsupported function, or invalid axis traversal).
    #[error("XPath evaluation error: {0}")]
    XPathEvalError(String),

    /// A `<` was found without a matching `>`. The byte offset points to the `<`.
    #[error("Unclosed tag at byte {0}")]
    UnclosedTag(usize),

    /// A `</name>` close tag does not match the expected open tag.
    #[error("Mismatched close tag: expected </{expected}>, got </{found}> at byte {offset}")]
    MismatchedCloseTag {
        expected: String,
        found: String,
        offset: usize,
    },

    /// The input is not valid XML (e.g., not valid UTF-8 or structurally broken).
    #[error("Invalid XML: {0}")]
    InvalidXml(String),

    /// An I/O error from reading XML files or `.sxi` index files.
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// The `.sxi` serialized index file is corrupt or has an incompatible format.
    #[error("Invalid .sxi file: {0}")]
    InvalidSxi(String),

    /// The `.sxi` index is stale: the XML file has been modified since the
    /// index was built. Re-parse with [`crate::load_or_parse`] to rebuild.
    #[error("Stale .sxi index: XML content has changed since index was built")]
    StaleSxi,
}

/// Alias for `Result<T, SimdXmlError>`.
pub type Result<T> = std::result::Result<T, SimdXmlError>;