covet 1.4.0

CLI and web frontend for scanning with HP Envy printer / scanners
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

use xmltree::Element;

use std::io::Read;
use std::str::FromStr;

use crate::message::error::ParseError;
use crate::message::util;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ScannerState {
    Idle,
    BusyWithScanJob,
    /// For example a paper jam
    AdfError,
}

impl FromStr for ScannerState {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<ScannerState, ParseError> {
        match s {
            "Idle" => Ok(ScannerState::Idle),
            "BusyWithScanJob" => Ok(ScannerState::BusyWithScanJob),
            "AdfError" => Ok(ScannerState::AdfError),
            _ => Err(ParseError::unknown_enum_value("ScannerState", s)),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum AdfState {
    Empty,
    Loaded,
    PickFailure,
}

impl FromStr for AdfState {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<AdfState, ParseError> {
        match s {
            "Empty" => Ok(AdfState::Empty),
            "Loaded" => Ok(AdfState::Loaded),
            "PickFailure" => Ok(AdfState::PickFailure),
            _ => Err(ParseError::unknown_enum_value("AdfState", s)),
        }
    }
}

#[derive(Debug)]
pub struct ScanStatus {
    scanner_state: ScannerState,
    adf_state: Option<AdfState>,
}

impl ScanStatus {
    pub fn new(scanner_state: ScannerState, adf_state: Option<AdfState>) -> ScanStatus {
        ScanStatus {
            scanner_state,
            adf_state,
        }
    }

    pub fn scanner_state(&self) -> ScannerState {
        self.scanner_state
    }

    pub fn is_idle(&self) -> bool {
        self.scanner_state == ScannerState::Idle
    }

    pub fn adf_state(&self) -> Option<AdfState> {
        self.adf_state
    }

    pub fn read_xml<R: Read>(r: R) -> Result<ScanStatus, ParseError> {
        let element = Element::parse(r)?;
        let scanner_state = util::parse_child_value(&element, "ScannerState")?;
        let adf_state = util::parse_optional_child_value(&element, "AdfState")?;
        Ok(ScanStatus::new(scanner_state, adf_state))
    }
}

#[cfg(test)]
mod test {

    use super::*;

    const SCAN_STATUS_IDLE: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
            <ScanStatus xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19">
            <ScannerState>Idle</ScannerState>
            <AdfState>Empty</AdfState>
            </ScanStatus>"#;

    const SCAN_STATUS_BUSY: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
            <ScanStatus xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19">
            <ScannerState>BusyWithScanJob</ScannerState>
            <AdfState>Empty</AdfState>
            </ScanStatus>"#;

    const SCAN_STATUS_LOADED: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
            <ScanStatus xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19">
            <ScannerState>Idle</ScannerState>
            <AdfState>Loaded</AdfState>
            </ScanStatus>"#;

    const SCAN_STATUS_ADF_ERROR: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
            <ScanStatus xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19">
            <ScannerState>AdfError</ScannerState>
            <AdfState>PickFailure</AdfState>
            </ScanStatus>"#;

    const SCAN_STATUS_UNKNOWN_ADF_STATE: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
            <ScanStatus xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19">
            <ScannerState>Idle</ScannerState>
            <AdfState>Laoded</AdfState>
            </ScanStatus>"#;

    const SCAN_STATUS_NO_ADF: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
            <ScanStatus xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19">
            <ScannerState>Idle</ScannerState>
            </ScanStatus>"#;

    #[test]
    fn read_scan_status_xml() {
        fn check_parse_scan_status(
            s: &str,
            scanner_state: ScannerState,
            adf_state: Option<AdfState>,
        ) {
            let status = s.as_bytes();
            let scan_status = ScanStatus::read_xml(status).expect("parsing failed");
            assert_eq!(scanner_state, scan_status.scanner_state());
            assert_eq!(adf_state, scan_status.adf_state());
        }
        check_parse_scan_status(SCAN_STATUS_IDLE, ScannerState::Idle, Some(AdfState::Empty));
        check_parse_scan_status(
            SCAN_STATUS_BUSY,
            ScannerState::BusyWithScanJob,
            Some(AdfState::Empty),
        );
        check_parse_scan_status(
            SCAN_STATUS_LOADED,
            ScannerState::Idle,
            Some(AdfState::Loaded),
        );
        check_parse_scan_status(SCAN_STATUS_NO_ADF, ScannerState::Idle, None);
        check_parse_scan_status(
            SCAN_STATUS_ADF_ERROR,
            ScannerState::AdfError,
            Some(AdfState::PickFailure),
        );
    }

    #[test]
    fn read_scan_status_xml_unknown_adf_state() {
        let error = ScanStatus::read_xml(SCAN_STATUS_UNKNOWN_ADF_STATE.as_bytes())
            .expect_err("parsing succeeded");
        assert_eq!(error.to_string(), "unknown AdfState: Laoded")
    }
}