Struct Document 

pub struct Document {}

The main entry point for a PDF Document.

Implementations

impl Document

pub fn text(&self) -> String

Extracts plain text from all pages.

pub fn page(&self, page_number: usize) -> Page

Accesses a specific page for text extraction and other operations (1-based index).

pub fn structured_text(&self) -> Vec<TextBlock>

Extracts structured text blocks with coordinates.

pub fn page_count(&self) -> usize

Returns the total number of pages in the document.

pub fn metadata(&self) -> Metadata

Returns the document’s metadata.

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), Error>

Saves the document to a file.

pub fn save_with<F>( &self, path: impl AsRef<Path>, build_opts: F, ) -> Result<(), Error>

where F: FnOnce(&mut SaveOptions) -> &mut SaveOptions,

Saves the document with specific options.

pub fn form_fields(&self) -> Vec<FormField>

Gets all form fields in the document.

pub fn fill_form(&self, fields: &[(&str, &str)]) -> Result<(), Error>

Fills form fields matching the provided name-value pairs.

pub fn flatten_forms(&self) -> Result<(), Error>

Flattens all forms, converting them to static content.

pub fn sign(&self, certificate: &[u8], private_key: &[u8]) -> Result<(), Error>

Signs the document using the provided certificate and private key.

pub fn signatures(&self) -> Vec<Signature>

Retrieves all signatures from the document.

pub fn verify_signatures(&self) -> Result<bool, Error>

Verifies the cryptographic validity of all signatures.

pub fn redact(&self, text: &str) -> Result<(), Error>

Redacts all occurrences of the specified text.

pub fn redact_region(&self, page: usize, rect: [f64; 4]) -> Result<(), Error>

Redacts a specific rectangular region on the specified page.

pub fn to_docx(&self, path: impl AsRef<Path>) -> Result<(), Error>

Converts the document to a DOCX file.

pub fn to_images(&self, pattern: &str, format: ImageFormat) -> Result<(), Error>

Renders the document’s pages to images based on a filename pattern.

pub fn is_pdfa_compliant(&self) -> Result<bool, Error>

Checks if the document is PDF/A compliant.

pub fn merge(&self, other_doc: &Document) -> Result<(), Error>

Merges another document into this one.

pub fn split_pages(&self) -> Result<Vec<Document>, Error>

Splits the document into individual 1-page documents.

pub fn rotate_page(&self, page: usize, angle: i32) -> Result<(), Error>

Rotates a specific page by the given angle (in degrees).

pub fn add_watermark( &self, text: &str, options: WatermarkOptions, ) -> Result<(), Error>

Adds a watermark to all pages of the document.