Struct PDDocument 

pub struct PDDocument {
    pub cos_doc: COSDocument,
    pub catalog: PDDocumentCatalog,
    pub pages: Vec<PDPage>,
    pub info: PDDocumentInformation,
}

High-level PDF document representing pages, metadata, catalog and content streams.

Fields

cos_doc: COSDocument

catalog: PDDocumentCatalog

pages: Vec<PDPage>

info: PDDocumentInformation

Implementations

impl PDDocument

pub fn new() -> Self

Creates a new, empty PDF document with catalog and info dictionaries.

pub fn load_from_bytes(bytes: &[u8]) -> PdfResult<Self>

Loads a PDF document from raw byte slice.

pub fn load_from_file(path: impl AsRef<Path>) -> PdfResult<Self>

Loads a PDF document from a file path.

pub fn page_count(&self) -> usize

Number of pages in the document.

pub fn pages(&self) -> &[PDPage]

Returns a slice of all pages.

pub fn pages_mut(&mut self) -> &mut [PDPage]

Returns a mutable slice of all pages.

pub fn get_page(&self, index: usize) -> PdfResult<&PDPage>

Gets a page reference by 0-based index.

pub fn get_page_mut(&mut self, index: usize) -> PdfResult<&mut PDPage>

Gets a mutable page reference by 0-based index.

pub fn add_page(&mut self, page: PDPage) -> ObjectId

Appends a new page to the document.

pub fn insert_page(&mut self, index: usize, page: PDPage) -> ObjectId

Inserts a page at a given 0-based index.

pub fn remove_page(&mut self, index: usize) -> PdfResult<()>

Removes a page by 0-based index.

pub fn sync(&mut self)

Synchronizes all modified pages, resources, and info metadata back to the COSDocument.

pub fn save_to_writer<W: Write>(&mut self, writer: W) -> PdfResult<()>

Saves the document to any writer implementing Write.

pub fn save_to_file(&mut self, path: impl AsRef<Path>) -> PdfResult<()>

Saves the document to a file.

pub fn save_incremental<W: Write>( &mut self, prev_bytes: &[u8], writer: W, ) -> PdfResult<()>

Appends an incremental update to original bytes and writes the result.

pub fn stamp(&self) -> Stamper

Creates a fluent Stamper for watermarking, headers/footers, and rubber stamps.

pub fn sign(&mut self, signer: Signer) -> PdfResult<Vec<u8>>

Digitally signs the document using the given Signer and returns the signed PDF bytes.

Trait Implementations

impl Clone for PDDocument

fn clone(&self) -> PDDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PDDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PDDocument

fn default() -> Self

Returns the “default value” for a type.