pdfium-render 0.9.0

A high-level idiomatic Rust wrapper around Pdfium, the C++ PDF library used by the Google Chromium project.
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
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

use crate::bindgen::{FPDF_ANNOTATION, FPDF_DOCUMENT, FPDF_PAGE};

/// The parent ownership hierarchy for a page object bound to a specific [PdfDocument].
#[derive(Copy, Clone)]
pub(crate) struct PdfPageObjectOwnedByDocument {
    document_handle: FPDF_DOCUMENT,
}

impl PdfPageObjectOwnedByDocument {
    pub fn document_handle(&self) -> FPDF_DOCUMENT {
        self.document_handle
    }
}

/// The parent ownership hierarchy for a page object contained by a [PdfPage].
#[derive(Copy, Clone)]
pub(crate) struct PdfPageObjectOwnedByPage {
    document_handle: FPDF_DOCUMENT,
    page_handle: FPDF_PAGE,
}

impl PdfPageObjectOwnedByPage {
    pub fn document_handle(&self) -> FPDF_DOCUMENT {
        self.document_handle
    }

    pub fn page_handle(&self) -> FPDF_PAGE {
        self.page_handle
    }
}

/// The parent ownership hierarchy for a page object contained by a [PdfPageAnnotation]
/// that is itself attached to a [PdfPage].
#[derive(Copy, Clone)]
pub(crate) struct PdfPageObjectOwnedByAttachedAnnotation {
    document_handle: FPDF_DOCUMENT,
    page_handle: FPDF_PAGE,
    annotation_handle: FPDF_ANNOTATION,
}

impl PdfPageObjectOwnedByAttachedAnnotation {
    pub fn document_handle(&self) -> FPDF_DOCUMENT {
        self.document_handle
    }

    pub fn page_handle(&self) -> FPDF_PAGE {
        self.page_handle
    }

    pub fn annotation_handle(&self) -> FPDF_ANNOTATION {
        self.annotation_handle
    }
}

/// The parent ownership hierarchy for a page object contained by a [PdfPageAnnotation]
/// where the [PdfPageAnnotation] is not currently attached to any [PdfPage].
#[derive(Copy, Clone)]
pub(crate) struct PdfPageObjectOwnedByUnattachedAnnotation {
    document_handle: FPDF_DOCUMENT,
    annotation_handle: FPDF_ANNOTATION,
}

impl PdfPageObjectOwnedByUnattachedAnnotation {
    pub fn document_handle(&self) -> FPDF_DOCUMENT {
        self.document_handle
    }

    pub fn annotation_handle(&self) -> FPDF_ANNOTATION {
        self.annotation_handle
    }
}

#[derive(Copy, Clone)]
pub(crate) enum PdfPageObjectOwnership {
    /// The object is not currently owned by an object container.
    Unowned,

    /// The object is not currently owned by an object container, but is bound to a specific [PdfDocument].
    /// It can only be attached to a [PdfPage] or [PdfPageAnnotation] within that document.
    Document(PdfPageObjectOwnedByDocument),

    /// The object is currently owned by an object container attached to a [PdfPage].
    Page(PdfPageObjectOwnedByPage),

    /// The object is currently owned by an object container attached to a [PdfPageAnnotation]
    /// that is itself attached to a [PdfPage].
    AttachedAnnotation(PdfPageObjectOwnedByAttachedAnnotation),

    /// The object is currently owned by an object container attached to a [PdfPageAnnotation]
    /// that is not currently attached to any [PdfPage].
    UnattachedAnnotation(PdfPageObjectOwnedByUnattachedAnnotation),
}

impl PdfPageObjectOwnership {
    pub fn unowned() -> Self {
        Self::Unowned
    }

    pub fn owned_by_document(document_handle: FPDF_DOCUMENT) -> Self {
        Self::Document(PdfPageObjectOwnedByDocument { document_handle })
    }

    pub fn owned_by_page(document_handle: FPDF_DOCUMENT, page_handle: FPDF_PAGE) -> Self {
        Self::Page(PdfPageObjectOwnedByPage {
            document_handle,
            page_handle,
        })
    }

    pub fn owned_by_attached_annotation(
        document_handle: FPDF_DOCUMENT,
        page_handle: FPDF_PAGE,
        annotation_handle: FPDF_ANNOTATION,
    ) -> Self {
        Self::AttachedAnnotation(PdfPageObjectOwnedByAttachedAnnotation {
            document_handle,
            page_handle,
            annotation_handle,
        })
    }

    pub fn owned_by_unattached_annotation(
        document_handle: FPDF_DOCUMENT,
        annotation_handle: FPDF_ANNOTATION,
    ) -> Self {
        Self::UnattachedAnnotation(PdfPageObjectOwnedByUnattachedAnnotation {
            document_handle,
            annotation_handle,
        })
    }

    /// Returns `true` if the memory allocated to the [PdfPageObject] holding
    /// this [PdfObjectOwnership] instance is owned by an object container attached to
    /// either a [PdfPage] or a [PdfAnnotation].
    pub fn is_owned(&self) -> bool {
        !matches!(self, PdfPageObjectOwnership::Unowned)
    }
}