gdtf 0.2.0

Tools to read and inspect General Device Type Format (GDTF) files.
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

use quick_xml::DeError;
use serde_path_to_error::Error;
use std::fmt::{Display, Formatter};
use thiserror::Error;
use zip::result::ZipError;

/// Generic result type with [GdtfError] as its error variant
pub type GdtfResult<T> = Result<T, GdtfError>;

/// Error type for operations with [GdtfFiles](crate::GdtfFile).
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum GdtfError {
    /// I/o error.
    Io(#[from] std::io::Error),

    /// Invalid XML.
    InvalidXml(Box<dyn std::error::Error + Send + Sync>),

    /// Specified resource not found in file.
    ResourceNotFound,
}

impl From<GdtfError> for std::io::Error {
    fn from(err: GdtfError) -> Self {
        let kind = match &err {
            GdtfError::Io(err) => err.kind(),
            GdtfError::InvalidXml(_) => std::io::ErrorKind::InvalidData,
            GdtfError::ResourceNotFound => std::io::ErrorKind::NotFound,
        };

        std::io::Error::new(kind, err)
    }
}

impl From<ZipError> for GdtfError {
    fn from(value: ZipError) -> Self {
        GdtfError::Io(value.into())
    }
}

impl From<DeError> for GdtfError {
    fn from(value: DeError) -> Self {
        GdtfError::InvalidXml(Box::new(value))
    }
}

impl From<serde_path_to_error::Error<DeError>> for GdtfError {
    fn from(value: Error<DeError>) -> Self {
        GdtfError::InvalidXml(Box::new(value))
    }
}

impl Display for GdtfError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            GdtfError::Io(io) => write!(f, "i/o error: {io}"),
            GdtfError::InvalidXml(inner) => write!(f, "invalid xml: {inner}"),
            GdtfError::ResourceNotFound => write!(f, "specified resource not found in file"),
        }
    }
}