API Reference

PDFluent SDK modules

The PDFluent SDK is organized into focused modules. Below is a summary of each module and its purpose. Full generated API docs are published to docs.rs at release.

Full API docs available on docs.rs after release

Document

pdfluent::document

The PdfDocument type. Open a file or bytes, read pages and metadata, save the result. Entry point for most SDK operations.

Page

pdfluent::Page

A read-only borrow of one page: its text, its dimensions and its number. Rotation, insertion and deletion are methods on the document, not on the page.

Form

pdfluent::form

AcroForm fields. Enumerate them with form_fields(), read the model with form_model(), fill through form_mut(), flatten with flatten_forms().

XFA

pdfluent::xfa

The XFA form model: fields with values, flags, choice options and geometry. Set a value with set_xfa_field_value, flatten to ordinary page content with flatten_xfa.

Compliance

pdfluent::compliance

PDF/A-1b, PDF/A-2b and PDF/A-3b validation and conversion. Returns a report of violations, each with its rule and severity.

Tagged

pdfluent::tagged

PDF/UA accessibility: check a document against the tagging requirements and remediate what can be remediated, with a report of what changed.

Encrypt

pdfluent::encrypt

Encryption and decryption. Set user and owner passwords, choose the algorithm, control permission flags per the PDF spec.

Redact

pdfluent::redact

Redaction that removes content rather than covering it, driven by options over the regions or patterns to remove.

Signer

pdfluent::signer

Sign with a PKCS#12 identity, or with your own PdfSigner implementation. Verify the signatures already on a document and read what is there.

Merger

pdfluent::merger

Combine documents. Add each input, choose how bookmarks are carried across, then build the result.

Text edit

pdfluent::text_edit

Find text with a query, replace it, and restyle a run in place. Reports what was replaced and what could not be.

Metadata

pdfluent::metadata

Read the document information dictionary and XMP, and write it back through a mutable handle.

Full API documentation

Every public type, method, and trait is documented inline and published automatically via cargo doc. After release, the complete API reference will be available on docs.rs. Until then, request early access docs via email.