90d1b9a83d
- Add test_page_json_with_page_labels_roman_numerals: verifies page_label serialization with roman numeral values (i, ii, iii, etc) - Add test_page_json_without_page_labels_absent: verifies page_label is absent (null) when PDF has no /PageLabels - Add test_page_json_page_index_and_page_number_both_present: verifies both page_index and page_number are always present and page_number = page_index + 1 - Add test_page_json_roundtrip_with_all_fields: verifies full roundtrip serde preservation of all PageJson fields - Update docs/schema/v1.0/pdftract.schema.json PageResult definition: - Add page_number field (1-based, = page_index + 1) - Add page_label field (optional, from /PageLabels number tree) - Add width and height fields (page geometry in points) - Add rotation field (0, 90, 180, 270 degrees) - Add type field with enum: text, scanned, mixed, broken_vector, blank, figure_only - Update required fields to include all page-level fields Acceptance criteria: ✅ Page serializes with both page_index AND page_number ✅ PDF with /PageLabels [{S: "r"}] produces page_label "i", "ii", "iii" etc ✅ PDF without /PageLabels -> page_label absent ✅ JSON Schema enum for page_type includes all values ✅ Roundtrip serde Page test passes Closes: pdftract-4c8qu |
||
|---|---|---|
| .. | ||
| benches | ||
| build | ||
| examples | ||
| proptest-regressions/parser/lexer | ||
| src | ||
| tests | ||
| __test__.pdf | ||
| build.rs | ||
| Cargo.toml | ||
| pdftract-core.cdx.json | ||
| README.md | ||
pdftract-core
The core Rust library for PDF text extraction. This crate provides the parsing, layout analysis, font encoding recovery, and text extraction primitives used by the CLI (pdftract-cli) and Python bindings (pdftract-py).
Cargo.lock Policy
This workspace checks in Cargo.lock at the repository root. This is unconventional for library crates—the Cargo Book historically suggested that only binary crates should check in lockfiles, allowing library consumers to resolve their own dependency versions.
pdftract departs from this convention for release reproducibility:
-
SLSA Level 3 provenance requires that every milestone tag produces byte-identical artifacts across builds. Without a checked-in lockfile, two runs of
cargo buildon the same commit can resolve different transitive dependency versions, producing different binary hashes. -
Multi-output artifacts—this workspace produces Rust crates (
pdftract-core,pdftract-cli), Python wheels (pdftract-py), and Docker images. All must be built from the same dependency tree. -
Supply-chain security—the lockfile pins checksums for all transitive dependencies, enabling
cargo auditto detect yanked or compromised crates. -
Downstream consumers can still ignore the lockfile if needed. Cargo allows
cargo build --frozenwith a local lockfile override, or consumers can vendor the crate with their own dependency resolution.
The tradeoff—occasional merge conflicts when PRs update overlapping dependencies—is worth the guarantee of reproducible releases. See CONTRIBUTING.md for the lockfile-update workflow.
Modules
parser: PDF spec parsing (xref, trailer, object streams, indirect references)font: Font encoding recovery, glyph name lookup, fingerprintinglayout: Page layout analysis, region segmentation, reading orderextract: Text extraction with provenance (bounding boxes, confidence scores)ocr: Tesseract integration for raster pages
Usage
use pdftract_core::{extract_text, ExtractOptions};
let options = ExtractOptions::default();
let result = extract_text("document.pdf", &options)?;
println!("{}", result.text);