spreadsheet_ods/
error.rs

1//!
2//! Error type.
3//!
4
5use kparse::{Code, TokenizerError};
6use nom_locate::LocatedSpan;
7use std::error::Error;
8use std::fmt::{Debug, Display, Formatter};
9use std::str::from_utf8;
10
11/// For conversion of TokenizerError.
12/// Analog of AsRef with static lifetime.
13pub(crate) trait AsStatic<T: ?Sized> {
14    fn as_static(&self) -> &'static T;
15}
16
17/// Result type.
18pub type OdsResult<T> = Result<T, OdsError>;
19
20#[derive(Debug)]
21#[allow(missing_docs)]
22pub enum OdsError {
23    Ods(String),
24    Io(std::io::Error),
25    Zip(zip::result::ZipError),
26    Xml(quick_xml::Error),
27    XmlAttr(quick_xml::events::attributes::AttrError),
28    XmlEncoding(quick_xml::encoding::EncodingError),
29    Utf8(std::str::Utf8Error),
30    Parse(&'static str, Option<String>),
31    ParseInt(std::num::ParseIntError),
32    ParseBool(std::str::ParseBoolError),
33    ParseFloat(std::num::ParseFloatError),
34    Chrono(chrono::format::ParseError),
35    SystemTime(std::time::SystemTimeError),
36    Base64(base64::DecodeError),
37}
38
39impl Display for OdsError {
40    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
41        match self {
42            OdsError::Ods(e) => write!(f, "Ods {}", e)?,
43            OdsError::Io(e) => write!(f, "IO {}", e)?,
44            OdsError::Zip(e) => write!(f, "Zip {:?}", e)?,
45            OdsError::Xml(e) => write!(f, "Xml {}", e)?,
46            OdsError::XmlAttr(e) => write!(f, "Xml attribute {}", e)?,
47            OdsError::XmlEncoding(e) => write!(f, "Xml encoding {}", e)?,
48            OdsError::Parse(e, v) => write!(f, "Parse {} {:?}", e, v)?,
49            OdsError::ParseInt(e) => write!(f, "ParseInt {}", e)?,
50            OdsError::ParseBool(e) => write!(f, "ParseBool {}", e)?,
51            OdsError::ParseFloat(e) => write!(f, "ParseFloat {}", e)?,
52            OdsError::Chrono(e) => write!(f, "Chrono {}", e)?,
53            OdsError::SystemTime(e) => write!(f, "SystemTime {}", e)?,
54            OdsError::Utf8(e) => write!(f, "UTF8 {}", e)?,
55            OdsError::Base64(e) => write!(f, "Base64 {}", e)?,
56        }
57
58        Ok(())
59    }
60}
61
62impl Error for OdsError {
63    fn cause(&self) -> Option<&dyn Error> {
64        match self {
65            OdsError::Ods(_) => None,
66            OdsError::Io(e) => Some(e),
67            OdsError::Zip(e) => Some(e),
68            OdsError::Xml(e) => Some(e),
69            OdsError::XmlAttr(e) => Some(e),
70            OdsError::XmlEncoding(e) => Some(e),
71            OdsError::Parse(_, _) => None,
72            OdsError::ParseInt(e) => Some(e),
73            OdsError::ParseBool(e) => Some(e),
74            OdsError::ParseFloat(e) => Some(e),
75            OdsError::Chrono(e) => Some(e),
76            OdsError::SystemTime(e) => Some(e),
77            OdsError::Utf8(e) => Some(e),
78            OdsError::Base64(e) => Some(e),
79        }
80    }
81}
82
83impl From<std::io::Error> for OdsError {
84    fn from(err: std::io::Error) -> OdsError {
85        OdsError::Io(err)
86    }
87}
88
89impl From<zip::result::ZipError> for OdsError {
90    fn from(err: zip::result::ZipError) -> OdsError {
91        OdsError::Zip(err)
92    }
93}
94
95impl From<quick_xml::Error> for OdsError {
96    fn from(err: quick_xml::Error) -> OdsError {
97        OdsError::Xml(err)
98    }
99}
100
101impl From<quick_xml::events::attributes::AttrError> for OdsError {
102    fn from(err: quick_xml::events::attributes::AttrError) -> OdsError {
103        OdsError::XmlAttr(err)
104    }
105}
106
107impl From<quick_xml::encoding::EncodingError> for OdsError {
108    fn from(err: quick_xml::encoding::EncodingError) -> OdsError {
109        OdsError::XmlEncoding(err)
110    }
111}
112
113impl From<std::str::ParseBoolError> for OdsError {
114    fn from(err: std::str::ParseBoolError) -> OdsError {
115        OdsError::ParseBool(err)
116    }
117}
118
119impl From<std::num::ParseIntError> for OdsError {
120    fn from(err: std::num::ParseIntError) -> OdsError {
121        OdsError::ParseInt(err)
122    }
123}
124
125impl From<std::num::ParseFloatError> for OdsError {
126    fn from(err: std::num::ParseFloatError) -> OdsError {
127        OdsError::ParseFloat(err)
128    }
129}
130
131impl From<chrono::format::ParseError> for OdsError {
132    fn from(err: chrono::format::ParseError) -> OdsError {
133        OdsError::Chrono(err)
134    }
135}
136
137impl From<std::time::SystemTimeError> for OdsError {
138    fn from(err: std::time::SystemTimeError) -> OdsError {
139        OdsError::SystemTime(err)
140    }
141}
142
143impl From<std::str::Utf8Error> for OdsError {
144    fn from(err: std::str::Utf8Error) -> OdsError {
145        OdsError::Utf8(err)
146    }
147}
148
149impl From<base64::DecodeError> for OdsError {
150    fn from(err: base64::DecodeError) -> OdsError {
151        OdsError::Base64(err)
152    }
153}
154
155impl<C> From<nom::Err<TokenizerError<C, &[u8]>>> for OdsError
156where
157    C: AsStatic<str>,
158{
159    fn from(value: nom::Err<TokenizerError<C, &[u8]>>) -> Self {
160        match value {
161            nom::Err::Incomplete(_) => OdsError::Parse("incomplete", None),
162            nom::Err::Error(e) | nom::Err::Failure(e) => OdsError::Parse(
163                e.code.as_static(),
164                Some(String::from_utf8_lossy(e.span).into()),
165            ),
166        }
167    }
168}
169
170impl<C> From<nom::Err<TokenizerError<C, &str>>> for OdsError
171where
172    C: AsStatic<str>,
173{
174    fn from(value: nom::Err<TokenizerError<C, &str>>) -> Self {
175        match value {
176            nom::Err::Incomplete(_) => OdsError::Parse("incomplete", None),
177            nom::Err::Error(e) | nom::Err::Failure(e) => {
178                OdsError::Parse(e.code.as_static(), Some(e.span.into()))
179            }
180        }
181    }
182}
183
184impl<'s, C, X> From<nom::Err<TokenizerError<C, LocatedSpan<&'s str, X>>>> for OdsError
185where
186    C: Code + AsStatic<str>,
187{
188    fn from(value: nom::Err<TokenizerError<C, LocatedSpan<&'s str, X>>>) -> Self {
189        match value {
190            nom::Err::Incomplete(_) => OdsError::Parse("incomplete", None),
191            nom::Err::Error(e) | nom::Err::Failure(e) => {
192                OdsError::Parse(e.code.as_static(), Some((*e.span).into()))
193            }
194        }
195    }
196}
197
198impl<'s, C, X> From<nom::Err<TokenizerError<C, LocatedSpan<&'s [u8], X>>>> for OdsError
199where
200    C: Code + AsStatic<str>,
201{
202    fn from(value: nom::Err<TokenizerError<C, LocatedSpan<&'s [u8], X>>>) -> Self {
203        match value {
204            nom::Err::Incomplete(_) => OdsError::Parse("incomplete", None),
205            nom::Err::Error(e) | nom::Err::Failure(e) => OdsError::Parse(
206                e.code.as_static(),
207                Some(from_utf8(*e.span).unwrap_or("decoding failed").into()),
208            ),
209        }
210    }
211}