API Documentation (Rustdoc)
The complete, item-level Rust documentation for rust-pdf-box is generated using Rust’s official cargo doc tool and bundled alongside this guide.
Direct Links to API Docs
Module Overview
The rust-pdf-box crate is divided into the following key modules:
| Module | Description |
|---|---|
prelude | The most common types, builders, and enums re-exported for easy glob import (use rust_pdf_box::prelude::*;). |
facade | PdfDocument - high-level, context-oriented document management, stamping, and signing facade. |
cos | Low-level PDF object system: COSObject, COSDocument, COSStream, COSArray, COSDictionary, parser, and lexer. |
pd | High-level Page Description layer: PDDocument, PDPage, PDRectangle, PDResources, and PDDocumentCatalog. |
content | Content stream engine: PDPageContentStream, path painting, clipping, color models, and graphics states. |
stamp | Fluent watermarking, rubber stamps, headers/footers, and page range selectors (PageRange, StampPosition). |
sign | Cryptographic signature engine: Signer, SignatureVerifier, visual appearances, and detached PKCS#7 signing. |
crypto | Pure-Rust cryptographic building blocks: ASN.1 DER encoder, X.509 v3 certificate generator, and RSA-SHA256 signer. |
interactive | Interactive AcroForms (PDAcroForm, PDFormField), form flattening, and page annotations (PDAnnotation). |
font | Standard 14 Type 1 PDF fonts (PDType1Font) and embedded TrueType fonts (PDTrueTypeFont). |
image | Image embedding (PDImageXObject), JPEG direct pass-through, and PNG with transparency /SMask. |
manipulation | Document assembly tools: PDFMerger and PDFSplitter. |
text | Text extraction engine: PDFTextStripper. |