Struct PDFDocument 

pub struct PDFDocument { /* private fields */ }

Represents a PDF document with all its components and functionality.

This struct encapsulates a parsed PDF document, providing access to its cross-reference table, version information, tokenizer, and page structure.

Implementations

impl PDFDocument

pub fn open(path: PathBuf) -> Result<PDFDocument>

Opens a PDF document from a file path.

This function opens a PDF file, reads its content, and parses it into a PDFDocument.

Arguments

• path - The path to the PDF file to open

Returns

A Result containing the parsed PDFDocument or an error if the file cannot be opened or parsed correctly

pub fn new(sequence: impl Sequence + 'static) -> Result<PDFDocument>

Creates a PDF document from a sequence of bytes.

This function parses a sequence of bytes representing a PDF document and constructs a PDFDocument instance with all its components.

Arguments

• sequence - A sequence implementation providing access to the PDF bytes

Returns

A Result containing the parsed PDFDocument or an error if parsing fails

pub fn get_xref_slice(&self) -> &[XEntry]

Gets a reference to the cross-reference table slice.

Returns

A slice reference to the vector of cross-reference entries

pub fn find_xref_index<F>(&self, visit: F) -> Option<usize>

where F: Fn(&XEntry) -> bool,

Finds the index of a cross-reference entry that matches a condition.

Arguments

• visit - A closure that takes a reference to an XEntry and returns a boolean

Returns

An optional index of the first matching entry, or None if no entry matches

pub fn get_version(&self) -> &PDFVersion

Gets the PDF version information.

Returns

A reference to the PDFVersion struct containing version information

pub fn read_object(&mut self, index: usize) -> Result<Option<PDFObject>>

Reads an object from the PDF document by its index.

Arguments

• index - The index of the object to read from the cross-reference table

Returns

A Result containing an optional PDFObject (None if the index is out of bounds or the object is freed) or an error if reading/parsing fails

pub fn read_object_with_ref( &mut self, tuple: ObjRefTuple, ) -> Result<Option<PDFObject>>

pub fn get_page_num(&self) -> usize

pub fn get_page_ids(&self) -> Vec<u64>

pub fn get_page(&self, node_id: u64) -> Option<&PageNode>