pdf-annotations-converter 0.2.0

Converts annotations found in PDF files to different formats.
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

/// Item that the parser emits.
#[derive(Debug, Clone, PartialEq)]
pub enum ParsedItem {
    /// The file which was annotated.
    File(String),
    /// A page number indicator, first element is printed number, second is physical page.
    PageNumber(u32, u32),
    /// A roman page indicator
    PageRoman(String),
    /// A higlighted section.
    Highlight(String),
    /// An underlined section.
    Underline(String),
}

/// The config provided to the parser.
pub struct ParseConfig {
    /// The offset of the first numbered page.
    /// Set it to a negative value if physical page numbers are annotated to derive page number
    /// from it.
    /// Set it to positive if page numbers are annotated to derive physical page from it.
    /// Set it to [0] if page numbers match physical page.
    pub page_offset: i32,
    /// If `true` page number indicators will be emitted.
    pub page_numbers: bool,
}

impl Default for ParseConfig {
    fn default() -> Self {
        Self {
            page_offset: 0,
            page_numbers: false,
        }
    }
}