pdf_oxide 0.3.22

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
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
//! Integration tests for the DOM-like PDF editing API.

#[cfg(test)]
mod dom_api_tests {
    use pdf_oxide::editor::{ElementId, PdfPage};
    use pdf_oxide::elements::{ContentElement, FontSpec, StructureElement, TextContent, TextStyle};
    use pdf_oxide::geometry::Rect;

    /// Create a test page with some sample content.
    fn create_test_page() -> PdfPage {
        let text1 = TextContent {
            text: "Hello World".to_string(),
            bbox: Rect::new(72.0, 720.0, 100.0, 12.0),
            font: FontSpec::new("Helvetica", 12.0),
            style: TextStyle::new(),
            ..Default::default()
        };

        let text2 = TextContent {
            text: "This is a test".to_string(),
            bbox: Rect::new(72.0, 700.0, 100.0, 12.0),
            font: FontSpec::new("Helvetica", 12.0),
            style: TextStyle::new(),
            ..Default::default()
        };

        let children = vec![ContentElement::Text(text1), ContentElement::Text(text2)];

        let root = StructureElement {
            structure_type: "Document".to_string(),
            bbox: Rect::new(0.0, 0.0, 612.0, 792.0),
            children,
            reading_order: Some(0),
            alt_text: None,
            language: None,
        };

        PdfPage::from_structure(0, root, 612.0, 792.0)
    }

    #[test]
    fn test_find_text_containing() {
        let page = create_test_page();

        let results = page.find_text_containing("Hello");
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].text(), "Hello World");
    }

    #[test]
    fn test_find_text_with_predicate() {
        let page = create_test_page();

        // Find text starting with "This"
        let results = page.find_text(|t| t.text().starts_with("This"));
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].text(), "This is a test");
    }

    #[test]
    fn test_find_text_no_match() {
        let page = create_test_page();

        let results = page.find_text_containing("Nonexistent");
        assert!(results.is_empty());
    }

    #[test]
    fn test_pdf_text_properties() {
        let page = create_test_page();

        let results = page.find_text_containing("Hello");
        assert_eq!(results.len(), 1);

        let text = &results[0];
        assert_eq!(text.text(), "Hello World");
        assert_eq!(text.bbox().x, 72.0);
        assert_eq!(text.bbox().y, 720.0);
        assert_eq!(text.font_name(), "Helvetica");
        assert_eq!(text.font_size(), 12.0);
        assert!(!text.is_bold());
        assert!(!text.is_italic());
    }

    #[test]
    fn test_element_id_uniqueness() {
        let id1 = ElementId::new();
        let id2 = ElementId::new();

        assert_ne!(id1, id2);
    }

    #[test]
    fn test_children_access() {
        let page = create_test_page();

        let children = page.children();
        assert_eq!(children.len(), 2);
    }

    #[test]
    fn test_match_pdf_element() {
        let page = create_test_page();
        let children = page.children();

        for element in children {
            match element {
                pdf_oxide::editor::PdfElement::Text(text) => {
                    assert!(!text.text().is_empty());
                },
                _ => panic!("Expected Text element"),
            }
        }
    }

    #[test]
    fn test_page_dimensions() {
        let page = create_test_page();

        assert_eq!(page.width, 612.0);
        assert_eq!(page.height, 792.0);
    }

    #[test]
    fn test_element_bbox() {
        let page = create_test_page();

        let results = page.find_text_containing("Hello");
        assert!(!results.is_empty());

        let bbox = results[0].bbox();
        assert_eq!(bbox.x, 72.0);
        assert_eq!(bbox.y, 720.0);
        assert_eq!(bbox.width, 100.0);
        assert_eq!(bbox.height, 12.0);
    }

    #[test]
    fn test_find_in_region() {
        let page = create_test_page();

        // Search in region covering first text
        let region = Rect::new(0.0, 710.0, 200.0, 30.0);
        let elements = page.find_in_region(region);

        assert!(!elements.is_empty());
        // Should find the first "Hello World" text
        if let Some(text) = elements[0].as_text() {
            assert_eq!(text.text(), "Hello World");
        }
    }

    #[test]
    fn test_find_in_region_no_match() {
        let page = create_test_page();

        // Search in region that doesn't contain any elements
        let region = Rect::new(0.0, 0.0, 50.0, 50.0);
        let elements = page.find_in_region(region);

        assert!(elements.is_empty());
    }

    #[test]
    fn test_pdf_page_creation() {
        let page = create_test_page();

        assert_eq!(page.page_index, 0);
        assert_eq!(page.width, 612.0);
        assert_eq!(page.height, 792.0);
    }

    #[test]
    fn test_all_find_methods() {
        let page = create_test_page();

        // find_text_containing
        let by_contains = page.find_text_containing("Hello");
        assert!(!by_contains.is_empty());

        // find_text with predicate
        let by_predicate = page.find_text(|t| t.text().contains("Hello"));
        assert!(!by_predicate.is_empty());

        // Should have same results
        assert_eq!(by_contains.len(), by_predicate.len());
    }

    #[test]
    fn test_empty_page() {
        let root = StructureElement {
            structure_type: "Document".to_string(),
            bbox: Rect::new(0.0, 0.0, 612.0, 792.0),
            children: Vec::new(),
            reading_order: Some(0),
            alt_text: None,
            language: None,
        };

        let page = PdfPage::from_structure(0, root, 612.0, 792.0);

        let results = page.find_text_containing("anything");
        assert!(results.is_empty());
    }

    #[test]
    fn test_fluent_api_find_and_modify() {
        let page = create_test_page();

        // Test fluent API with mutable modification
        let editor = pdf_oxide::editor::PageEditor { page };
        let result = editor
            .find_text_containing("Hello")
            .expect("find_text_containing failed");

        let modified = result
            .for_each(|text| {
                text.set_text("Hi");
                Ok(())
            })
            .expect("for_each failed")
            .done()
            .expect("done failed");

        // Verify the modification happened
        let modified_text = modified.find_text_containing("Hi");
        assert_eq!(modified_text.len(), 1);
        assert_eq!(modified_text[0].text(), "Hi");
    }

    #[test]
    fn test_fluent_api_chaining() {
        let page = create_test_page();

        // Test fluent API chaining style (XMLDocument-like)
        let result = pdf_oxide::editor::PageEditor { page }
            .find_text_containing("Hello")
            .expect("find_text_containing failed")
            .for_each(|text| {
                text.set_text("Modified");
                Ok(())
            })
            .expect("for_each failed")
            .done();

        assert!(result.is_ok());
        let modified_page = result.unwrap();
        let modified_text = modified_page.find_text_containing("Modified");
        assert_eq!(modified_text.len(), 1);
    }

    #[test]
    fn test_fluent_api_with_predicate() {
        let page = create_test_page();

        let result = pdf_oxide::editor::PageEditor { page }
            .find_text(|t| t.text().starts_with("Hello"))
            .expect("find_text failed")
            .for_each(|text| {
                text.set_text("Updated");
                Ok(())
            })
            .expect("for_each failed")
            .done();

        assert!(result.is_ok());
        let modified_page = result.unwrap();
        let updated_text = modified_page.find_text_containing("Updated");
        assert_eq!(updated_text.len(), 1);
        assert_eq!(updated_text[0].text(), "Updated");
    }

    #[test]
    fn test_dom_with_real_pdf() {
        use pdf_oxide::editor::DocumentEditor;

        // Test that DOM text extraction works on a real PDF
        let mut editor =
            DocumentEditor::open("tests/fixtures/simple.pdf").expect("Failed to open test PDF");

        // get_page should succeed even if the page has no content
        let page = editor.get_page(0).expect("Failed to get page 0");

        // Find all text elements
        let all_text = page.find_text(|_| true);
        println!("Found {} text elements on simple.pdf", all_text.len());

        // Note: simple.pdf is a minimal test fixture that may have no text content
        // This test verifies the DOM API works, not that there's text in this file
        // Print first few text elements for debugging
        for (i, t) in all_text.iter().take(3).enumerate() {
            println!("  [{}] '{}' at ({:.1}, {:.1})", i, t.text(), t.bbox().x, t.bbox().y);
        }
    }

    #[test]
    fn test_dom_text_modification_in_memory() {
        // Test that DOM text modification works on an in-memory page
        let page = create_test_page();

        let texts = page.find_text(|_| true);
        assert!(!texts.is_empty(), "Test page should have text elements");

        // Get the ID of the first text element
        let first_id = texts[0].id();
        let original_text = texts[0].text().to_string();

        // Create a new page with the modification
        let mut page = page;

        // Modify the text
        page.set_text(first_id, "MODIFIED")
            .expect("Failed to set text");

        // Verify the modification
        if let Some(element) = page.get_element(first_id) {
            if let Some(text) = element.as_text() {
                assert_eq!(text.text(), "MODIFIED");
                println!("Successfully modified text from '{}' to 'MODIFIED'", original_text);
            }
        }
    }

    #[test]
    fn test_dom_round_trip_create_and_read() {
        use pdf_oxide::editor::DocumentEditor;
        use pdf_oxide::writer::{DocumentBuilder, PageSize};
        use std::io::Write;
        use tempfile::NamedTempFile;

        // Create a PDF with text using the DocumentBuilder API
        let mut builder = DocumentBuilder::new();
        builder
            .page(PageSize::Letter)
            .at(72.0, 720.0)
            .font("Helvetica", 24.0)
            .text("Hello PDF World")
            .at(72.0, 680.0)
            .font("Helvetica", 12.0)
            .text("This is a test document")
            .done();
        builder
            .page(PageSize::Letter)
            .at(72.0, 700.0)
            .text("Page 2 content")
            .done();
        let pdf_bytes = builder.build().expect("Failed to build PDF");

        // Write to a temp file
        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        temp_file
            .write_all(&pdf_bytes)
            .expect("Failed to write PDF");
        let path = temp_file.path().to_path_buf();

        // Read the PDF back using DocumentEditor
        let mut editor = DocumentEditor::open(&path).expect("Failed to open generated PDF");

        // Verify we can read text from page 0
        let page0 = editor.get_page(0).expect("Failed to get page 0");
        let texts = page0.find_text(|_| true);

        println!("Found {} text elements on page 0", texts.len());
        for (i, t) in texts.iter().enumerate() {
            println!("  [{}] '{}' at ({:.1}, {:.1})", i, t.text(), t.bbox().x, t.bbox().y);
        }

        // Verify we found the expected text
        assert!(!texts.is_empty(), "Should find text on the generated PDF page");

        // Check that we can find specific text
        let hello_texts = page0.find_text_containing("Hello");
        assert!(!hello_texts.is_empty(), "Should find 'Hello' on the page");
        println!("Found 'Hello' in: '{}'", hello_texts[0].text());

        // Check page 1
        let page1 = editor.get_page(1).expect("Failed to get page 1");
        let page1_texts = page1.find_text(|_| true);
        assert!(!page1_texts.is_empty(), "Should find text on page 1");
        println!("Page 1 has {} text elements", page1_texts.len());
    }

    #[test]
    fn test_unified_pdf_api_metadata() {
        use pdf_oxide::api::Pdf;
        use pdf_oxide::writer::{DocumentBuilder, PageSize};
        use std::io::Write;
        use tempfile::NamedTempFile;

        // Create a PDF to work with
        let mut builder = DocumentBuilder::new();
        builder
            .page(PageSize::Letter)
            .at(72.0, 720.0)
            .font("Helvetica", 12.0)
            .text("Test document")
            .done();
        let pdf_bytes = builder.build().expect("Failed to build PDF");

        // Write to temp file
        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        temp_file
            .write_all(&pdf_bytes)
            .expect("Failed to write PDF");
        let path = temp_file.path();

        // Open with unified API
        let mut pdf = Pdf::open(path).expect("Failed to open PDF");

        // Test metadata methods
        pdf.set_title("Test Title").expect("Failed to set title");
        pdf.set_author("Test Author").expect("Failed to set author");
        pdf.set_subject("Test Subject")
            .expect("Failed to set subject");
        pdf.set_keywords("test, pdf, metadata")
            .expect("Failed to set keywords");

        // Verify is_modified returns true after changes
        assert!(pdf.is_modified(), "Document should be modified after setting metadata");
    }

    #[test]
    fn test_unified_pdf_api_page_access() {
        use pdf_oxide::api::Pdf;
        use pdf_oxide::writer::{DocumentBuilder, PageSize};
        use std::io::Write;
        use tempfile::NamedTempFile;

        // Create a PDF with text
        let mut builder = DocumentBuilder::new();
        builder
            .page(PageSize::Letter)
            .at(72.0, 720.0)
            .font("Helvetica", 18.0)
            .text("Hello World")
            .done();
        let pdf_bytes = builder.build().expect("Failed to build PDF");

        // Write to temp file
        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        temp_file
            .write_all(&pdf_bytes)
            .expect("Failed to write PDF");
        let path = temp_file.path();

        // Open with unified API
        let mut pdf = Pdf::open(path).expect("Failed to open PDF");

        // Test page count
        let count = pdf.page_count().expect("Failed to get page count");
        assert_eq!(count, 1, "Should have 1 page");

        // Test page access
        let page = pdf.page(0).expect("Failed to get page 0");

        // Find text
        let texts = page.find_text_containing("Hello");
        assert!(!texts.is_empty(), "Should find 'Hello' on the page");
    }

    #[test]
    fn test_page_add_and_remove_text() {
        use pdf_oxide::api::Pdf;
        use pdf_oxide::api::TextContent;
        use pdf_oxide::writer::{DocumentBuilder, PageSize};
        use std::io::Write;
        use tempfile::NamedTempFile;

        // Create a PDF
        let mut builder = DocumentBuilder::new();
        builder
            .page(PageSize::Letter)
            .at(72.0, 720.0)
            .font("Helvetica", 12.0)
            .text("Original")
            .done();
        let pdf_bytes = builder.build().expect("Failed to build PDF");

        // Write to temp file
        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        temp_file
            .write_all(&pdf_bytes)
            .expect("Failed to write PDF");
        let path = temp_file.path();

        // Open and modify
        let mut pdf = Pdf::open(path).expect("Failed to open PDF");

        {
            let mut page = pdf.page(0).expect("Failed to get page");

            // Add new text using TextContent
            let text_content = TextContent {
                text: "New Text".to_string(),
                bbox: Rect::new(100.0, 650.0, 80.0, 14.0),
                ..Default::default()
            };
            let text_id = page.add_text(text_content);

            // Verify the text was added
            let new_texts = page.find_text_containing("New Text");
            assert!(!new_texts.is_empty(), "Should find newly added text");

            // Remove the text
            let removed = page.remove_element(text_id);
            assert!(removed, "Should successfully remove the element");

            // Verify removal
            let after_remove = page.find_text_containing("New Text");
            assert!(after_remove.is_empty(), "Text should be removed");
        }
    }

    #[test]
    fn test_page_annotations() {
        use pdf_oxide::api::{LinkAnnotation, Pdf, Rect as ApiRect, TextAnnotation};
        use pdf_oxide::writer::{DocumentBuilder, PageSize};
        use std::io::Write;
        use tempfile::NamedTempFile;

        // Create a PDF
        let mut builder = DocumentBuilder::new();
        builder
            .page(PageSize::Letter)
            .at(72.0, 720.0)
            .font("Helvetica", 12.0)
            .text("Document with annotations")
            .done();
        let pdf_bytes = builder.build().expect("Failed to build PDF");

        // Write to temp file
        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        temp_file
            .write_all(&pdf_bytes)
            .expect("Failed to write PDF");
        let path = temp_file.path();

        // Open and add annotations
        let mut pdf = Pdf::open(path).expect("Failed to open PDF");

        {
            let mut page = pdf.page(0).expect("Failed to get page");

            // Add a link annotation using proper types
            let link =
                LinkAnnotation::uri(ApiRect::new(72.0, 700.0, 100.0, 20.0), "https://example.com");
            let _link_id = page.add_annotation(link);

            // Add a note/text annotation
            let note =
                TextAnnotation::new(ApiRect::new(200.0, 700.0, 20.0, 20.0), "This is a comment");
            let _note_id = page.add_annotation(note);

            // Get all annotations
            let annotations = page.annotations();
            assert!(annotations.len() >= 2, "Should have at least 2 annotations");

            // Check first annotation properties
            let first = &annotations[0];
            let rect = first.rect();
            assert!(rect.x >= 0.0 && rect.width > 0.0, "Rect should have valid dimensions");
        }
    }
}