qpdf 0.3.5

Rust bindings to QPDF C++ library
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

use std::ffi::NulError;
use std::fmt;

use crate::Result;

/// Error codes returned by QPDF library calls
#[derive(Debug, Clone, Copy, Eq, PartialEq, PartialOrd, Hash, Default)]
pub enum QPdfErrorCode {
    #[default]
    Unknown,
    InvalidParameter,
    InternalError,
    SystemError,
    Unsupported,
    InvalidPassword,
    DamagedPdf,
    PagesError,
    ObjectError,
}

pub(crate) fn error_or_ok(error: qpdf_sys::qpdf_error_code_e) -> Result<()> {
    let code = match error as qpdf_sys::qpdf_error_code_e {
        qpdf_sys::qpdf_error_code_e_qpdf_e_success => return Ok(()),
        qpdf_sys::qpdf_error_code_e_qpdf_e_internal => QPdfErrorCode::InternalError,
        qpdf_sys::qpdf_error_code_e_qpdf_e_system => QPdfErrorCode::SystemError,
        qpdf_sys::qpdf_error_code_e_qpdf_e_unsupported => QPdfErrorCode::Unsupported,
        qpdf_sys::qpdf_error_code_e_qpdf_e_password => QPdfErrorCode::InvalidPassword,
        qpdf_sys::qpdf_error_code_e_qpdf_e_damaged_pdf => QPdfErrorCode::DamagedPdf,
        qpdf_sys::qpdf_error_code_e_qpdf_e_pages => QPdfErrorCode::PagesError,
        qpdf_sys::qpdf_error_code_e_qpdf_e_object => QPdfErrorCode::ObjectError,
        _ => QPdfErrorCode::Unknown,
    };
    Err(QPdfError {
        error_code: code,
        description: None,
        position: None,
    })
}

/// QPdfError holds an error code and an optional extra information
#[derive(Debug, Clone, Eq, PartialEq, PartialOrd, Default)]
pub struct QPdfError {
    pub(crate) error_code: QPdfErrorCode,
    pub(crate) description: Option<String>,
    pub(crate) position: Option<u64>,
}

impl fmt::Display for QPdfError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{:?}: {}",
            self.error_code,
            self.description.as_deref().unwrap_or_default()
        )
    }
}

impl std::error::Error for QPdfError {}

impl QPdfError {
    pub fn error_code(&self) -> QPdfErrorCode {
        self.error_code
    }

    pub fn description(&self) -> Option<&str> {
        self.description.as_deref()
    }

    pub fn position(&self) -> Option<u64> {
        self.position
    }
}

impl From<NulError> for QPdfError {
    fn from(_: NulError) -> Self {
        QPdfError {
            error_code: QPdfErrorCode::InvalidParameter,
            description: Some("Unexpected null code in the string parameter".to_owned()),
            position: None,
        }
    }
}