pdfluent-extract 1.0.0-beta.3

PDF content extraction: images, text with positions, and full-text search
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

//! PDF content extraction: text with positions, images, and full-text search.
//!
//! Works directly on [`lopdf::Document`] objects, which can be loaded from a
//! file with `Document::load`. Three extraction targets are available:
//!
//! - **Text** — plain strings or [`TextBlock`] records with page, font, bbox
//! - **Positioned characters** — per-character [`PositionedChar`] with bounding boxes
//! - **Images** — [`ExtractedImage`] with raw pixel data and format metadata
//! - **Search** — substring search with [`SearchResult`] entries (page + bboxes)
//!
//! # Quick Start
//!
//! ```no_run
//! use lopdf::Document;
//! use pdf_extract::{extract_text, extract_page_text, search_text, SearchOptions};
//!
//! let doc = Document::load("document.pdf").unwrap();
//!
//! // All text blocks from every page.
//! for block in extract_text(&doc) {
//!     println!("[page {}] {} (font: {}, size: {:.1}pt)",
//!         block.page, block.text, block.font_name, block.font_size);
//! }
//!
//! // Plain text from one page (1-based page number).
//! let text = extract_page_text(&doc, 1).unwrap();
//!
//! // Full-text search with bounding boxes.
//! let opts = SearchOptions { case_insensitive: true, ..Default::default() };
//! for result in search_text(&doc, "invoice", &opts) {
//!     println!("Page {}: {:?} ({} bboxes)",
//!         result.page, result.text, result.bounding_boxes.len());
//! }
//! ```
//!
//! # Key Types
//!
//! | Type | Description |
//! |---|---|
//! | [`TextBlock`] | Text run with page number, bounding box, font name/size |
//! | [`PositionedChar`] | Single character with per-character bounding box |
//! | [`ExtractedImage`] | Raw image data extracted from a page |
//! | [`SearchResult`] | Match with page, text, character bounding boxes, offset |
//! | [`SearchOptions`] | Case sensitivity, page filter, max results, bbox toggle |

pub mod error;
pub mod images;
pub mod search;
pub mod text;

pub use error::{ExtractError, Result};
pub use images::{
    extract_all_images, extract_images_from_page_id, extract_page_images, ExtractedImage,
    ImageFilter,
};
pub use search::{
    count_occurrences, count_text_only, pages_containing, search_text, SearchOptions, SearchResult,
};
pub use text::{
    extract_blocks_from_page_id, extract_page_blocks, extract_page_text, extract_positioned_chars,
    extract_text, PositionedChar, TextBlock,
};