pdf_oxide 0.3.39

The fastest Rust PDF library with text extraction: 0.8ms mean, 100% pass rate on 3,830 PDFs. 5× faster than pdf_extract, 17× faster than oxidize_pdf. Extract, create, and edit PDFs.
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

//! Signature field widget placeholder for PDF forms.
//!
//! Implements an unsigned `/FT /Sig` field per ISO 32000-1:2008 §12.8.
//! The field acts as a reserved slot that a signing application can fill
//! in later; no cryptographic signature is embedded at creation time.

use super::{FormFieldEntry, FormFieldWidget};
use crate::geometry::Rect;
use crate::object::{Object, ObjectRef};
use std::collections::HashMap;

/// An unsigned signature field placeholder.
///
/// Places a visible signature box on the page. The `/V` value is `null`
/// (unsigned). A signing tool can fill it in via incremental update.
#[derive(Debug, Clone)]
pub struct SignatureWidget {
    /// Partial field name
    name: String,
    /// Bounding rectangle
    rect: Rect,
    /// Optional tooltip
    tooltip: Option<String>,
    /// Read-only flag
    read_only: bool,
}

impl SignatureWidget {
    /// Create a new unsigned signature placeholder.
    pub fn new(name: impl Into<String>, rect: Rect) -> Self {
        Self {
            name: name.into(),
            rect,
            tooltip: None,
            read_only: false,
        }
    }

    /// Set tooltip text.
    pub fn with_tooltip(mut self, tip: impl Into<String>) -> Self {
        self.tooltip = Some(tip.into());
        self
    }

    /// Mark the field as read-only (viewer shows it but won't let it be signed).
    pub fn read_only(mut self) -> Self {
        self.read_only = true;
        self
    }

    /// Build to a `FormFieldEntry`.
    pub fn build_entry(&self, page_ref: ObjectRef) -> FormFieldEntry {
        FormFieldEntry {
            widget_dict: self.build_widget_dict(page_ref),
            field_dict: self.build_field_dict(),
            name: self.name.clone(),
            rect: self.rect,
            field_type: "Sig".to_string(),
        }
    }
}

impl FormFieldWidget for SignatureWidget {
    fn field_name(&self) -> &str {
        &self.name
    }

    fn rect(&self) -> Rect {
        self.rect
    }

    fn field_type(&self) -> &'static str {
        "Sig"
    }

    fn field_flags(&self) -> u32 {
        if self.read_only {
            1
        } else {
            0
        }
    }

    fn build_field_dict(&self) -> HashMap<String, Object> {
        let mut dict = HashMap::new();
        dict.insert("FT".to_string(), Object::Name("Sig".to_string()));
        dict.insert("T".to_string(), Object::text_string(&self.name));
        // /V = null means the field is unsigned
        dict.insert("V".to_string(), Object::Null);
        if self.read_only {
            dict.insert("Ff".to_string(), Object::Integer(1));
        }
        if let Some(ref tip) = self.tooltip {
            dict.insert("TU".to_string(), Object::text_string(tip));
        }
        dict
    }

    fn build_widget_dict(&self, page_ref: ObjectRef) -> HashMap<String, Object> {
        let mut dict = HashMap::new();
        dict.insert("Type".to_string(), Object::Name("Annot".to_string()));
        dict.insert("Subtype".to_string(), Object::Name("Widget".to_string()));
        dict.insert(
            "Rect".to_string(),
            Object::Array(vec![
                Object::Real(self.rect.x as f64),
                Object::Real(self.rect.y as f64),
                Object::Real((self.rect.x + self.rect.width) as f64),
                Object::Real((self.rect.y + self.rect.height) as f64),
            ]),
        );
        dict.insert("P".to_string(), Object::Reference(page_ref));
        // /H /N — no highlight effect for signature widgets
        dict.insert("H".to_string(), Object::Name("N".to_string()));
        dict
    }
}