adf 0.2.0

Minimal-overhead Auto-lead Data Format XML parser and writer
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use std::fmt;

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug)]
pub enum Error {
    Xml {
        position: u64,
        source: quick_xml::Error,
    },
    Attribute {
        position: u64,
        source: quick_xml::events::attributes::AttrError,
    },
    Encoding {
        position: u64,
        source: quick_xml::encoding::EncodingError,
    },
    Utf8 {
        position: u64,
        source: std::str::Utf8Error,
    },
    MismatchedEnd {
        expected: String,
        found: String,
        position: u64,
    },
    UnexpectedEnd {
        name: String,
        position: u64,
    },
    ContentOutsideRoot {
        position: u64,
    },
    InvalidCharacterReference {
        reference: String,
        position: u64,
    },
    MissingRoot,
    MultipleRoots,
    Io(std::io::Error),
}

impl Error {
    pub(crate) fn xml(position: u64, source: quick_xml::Error) -> Self {
        Self::Xml { position, source }
    }

    pub(crate) fn encoding(position: u64, source: quick_xml::encoding::EncodingError) -> Self {
        Self::Encoding { position, source }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Xml { position, source } => {
                write!(f, "XML error at byte {position}: {source}")
            }
            Error::Attribute { position, source } => {
                write!(f, "XML attribute error at byte {position}: {source}")
            }
            Error::Encoding { position, source } => {
                write!(f, "XML encoding error at byte {position}: {source}")
            }
            Error::Utf8 { position, source } => {
                write!(f, "UTF-8 error at byte {position}: {source}")
            }
            Error::MismatchedEnd {
                expected,
                found,
                position,
            } => write!(
                f,
                "mismatched closing tag at byte {position}: expected </{expected}>, found </{found}>"
            ),
            Error::UnexpectedEnd { name, position } => {
                write!(f, "unexpected closing tag </{name}> at byte {position}")
            }
            Error::ContentOutsideRoot { position } => {
                write!(
                    f,
                    "non-document content outside the root element at byte {position}"
                )
            }
            Error::InvalidCharacterReference {
                reference,
                position,
            } => {
                write!(
                    f,
                    "invalid XML character reference &{reference}; at byte {position}"
                )
            }
            Error::MissingRoot => f.write_str("document does not contain a root element"),
            Error::MultipleRoots => f.write_str("document contains more than one root element"),
            Error::Io(source) => write!(f, "I/O error: {source}"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::Xml { source, .. } => Some(source),
            Error::Attribute { source, .. } => Some(source),
            Error::Encoding { source, .. } => Some(source),
            Error::Utf8 { source, .. } => Some(source),
            Error::Io(source) => Some(source),
            _ => None,
        }
    }
}

impl From<std::io::Error> for Error {
    fn from(source: std::io::Error) -> Self {
        Self::Io(source)
    }
}