f106b5df02
Define the PdfSource trait abstraction over PDF byte sources. This trait provides a uniform API for reading PDF data from different sources: local files (MmapSource, FileSource), and eventually remote HTTPS PDFs. Trait features: - Read + Seek + Send + Sync supertrait bounds for rayon page-parallelism - len() returns total source length - read_range() returns Bytes for zero-copy slicing - prefetch() with no-op default (MmapSource overrides for MADV_SEQUENTIAL) MmapSource: - Memory-mapped file access via memmap2 - Applies MADV_SEQUENTIAL advice via prefetch() - Zero-copy read_range() using Bytes::copy_from_slice() - Fallback for platforms/filesystems where mmap fails FileSource: - Standard I/O implementation using std::fs::File - Read+Seek delegation to underlying File - read_range() uses try_clone() for thread-safe concurrent access Re-exports from pdftract-core::source::PdfSource. Verification note: notes/pdftract-1mmq9.md documents completion status. Parser module migration to use new PdfSource is deferred to follow-up. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| 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);