minidom/
error.rs

1// Copyright (c) 2020 lumi <lumi@pew.im>
2// Copyright (c) 2020 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
3// Copyright (c) 2020 Bastien Orivel <eijebong+minidom@bananium.fr>
4// Copyright (c) 2020 Astro <astro@spaceboyz.net>
5// Copyright (c) 2020 Maxime “pep” Buquet <pep@bouah.net>
6// Copyright (c) 2020 Matt Bilker <me@mbilker.us>
7//
8// This Source Code Form is subject to the terms of the Mozilla Public
9// License, v. 2.0. If a copy of the MPL was not distributed with this
10// file, You can obtain one at http://mozilla.org/MPL/2.0/.
11
12//! Provides an error type for this crate.
13
14use std::io;
15
16use core::{error::Error as StdError, fmt};
17
18/// Our main error type.
19#[derive(Debug)]
20pub enum Error {
21    /// Error from rxml parsing or writing
22    XmlError(rxml::Error),
23
24    /// I/O error from accessing the source or destination.
25    ///
26    /// Even though the [`rxml`] crate emits its errors through
27    /// [`io::Error`] when using it with [`BufRead`][`io::BufRead`],
28    /// any rxml errors will still be reported through the
29    /// [`XmlError`][`Self::XmlError`] variant.
30    Io(io::Error),
31
32    /// An error which is returned when the end of the document was reached prematurely.
33    EndOfDocument,
34
35    /// An error which is returned when an element being serialized doesn't contain a prefix
36    /// (be it None or Some(_)).
37    InvalidPrefix,
38
39    /// An error which is returned when an element doesn't contain a namespace
40    MissingNamespace,
41
42    /// An error which is returned when a prefixed is defined twice
43    DuplicatePrefix,
44}
45
46impl StdError for Error {
47    fn cause(&self) -> Option<&dyn StdError> {
48        match self {
49            Error::XmlError(e) => Some(e),
50            Error::Io(e) => Some(e),
51            Error::EndOfDocument
52            | Error::InvalidPrefix
53            | Error::MissingNamespace
54            | Error::DuplicatePrefix => None,
55        }
56    }
57}
58
59impl From<io::Error> for Error {
60    fn from(other: io::Error) -> Self {
61        match other.downcast::<rxml::Error>() {
62            Ok(e) => Self::XmlError(e),
63            Err(e) => Self::Io(e),
64        }
65    }
66}
67
68impl fmt::Display for Error {
69    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
70        match self {
71            Error::XmlError(e) => write!(fmt, "XML error: {e}"),
72            Error::Io(e) => write!(fmt, "I/O error: {e}"),
73            Error::EndOfDocument => {
74                write!(fmt, "the end of the document has been reached prematurely")
75            }
76            Error::InvalidPrefix => write!(fmt, "the prefix is invalid"),
77            Error::MissingNamespace => write!(fmt, "the XML element is missing a namespace",),
78            Error::DuplicatePrefix => write!(fmt, "the prefix is already defined"),
79        }
80    }
81}
82
83impl From<rxml::Error> for Error {
84    fn from(err: rxml::Error) -> Error {
85        Error::XmlError(err)
86    }
87}
88
89impl From<rxml::strings::Error> for Error {
90    fn from(err: rxml::strings::Error) -> Error {
91        rxml::error::Error::from(err).into()
92    }
93}
94
95/// Our simplified Result type.
96pub type Result<T> = ::core::result::Result<T, Error>;
minidom/error.rs

minidom/
error.rs
