Module api 

The ideal top-level API facade for the PDFluent SDK.

This module defines the intended public surface of the PDFluent library, following the “Zero-Config First Success”, “Pit of Success”, and “Progressive Disclosure” design principles.

Re-exports

pub use crate::api_error::Error;

Structs

Document

The main entry point for a PDF Document.

FormField

An interactive form field as seen by the form-fill API. One entry per terminal field; group fields are flattened. Returned by Document::form_fields.

Metadata

Document-level metadata read from the /Info dictionary or XMP. All fields are None if absent. Returned by Document::metadata.

Page

Represents a single page within a Document.

ReadOptions

Options for reading a PDF.

SaveOptions

Options for saving a PDF.

Signature

A digital signature widget found in the document. Returned by Document::signatures; cryptographic verification is performed separately by Document::verify_signatures.

TextBlock

A structured block of text from a PDF, with its bounding box on the page. Returned by Document::structured_text.

WatermarkOptions

Options for Document::add_watermark. Defaults: opaque, unrotated.

Enums

ImageFormat

Output format selector for Document::to_images. PNG for line art / text, JPEG for photographic content.

PdfFormat

PDF or PDF/A target version that the saver should emit. Used by SaveOptions::format.

PdfSource

Input source for a PDF document — accepts either a filesystem path or in-memory bytes.

Functions

read

Reads a PDF document from a file path or bytes, using default options.

read_with

Reads a PDF document with custom options (e.g., providing a password).