Struct PdfDocument 

pub struct PdfDocument {
    pub version: (u8, u8),
    pub xref: Xref,
    /* private fields */
}

A parsed PDF document.

PdfDocument uses interior mutability (RwLock) for its object caches so that resolve only requires &self. This makes the type Sync and enables multi-threaded page parsing and rendering via shared references.

Fields

version: (u8, u8)

PDF version, e.g. (1, 7) for PDF 1.7.

xref: Xref

The merged cross-reference table.

Implementations

impl PdfDocument

pub fn open(path: &Path) -> Result<Self>

Open a PDF file from a path.

pub fn from_bytes(data: Vec<u8>) -> Result<Self>

Parse a PDF from an in-memory byte vector.

pub fn is_encrypted(&self) -> bool

Whether the document is encrypted.

pub fn is_authenticated(&self) -> bool

Whether the document is encrypted and authentication has succeeded.

pub fn authenticate(&mut self, password: &[u8]) -> Result<()>

Authenticate with a password. Required for encrypted documents where the empty password doesn’t work.

pub fn permissions(&self) -> Option<Permissions>

Get the permission flags (if encrypted).

pub fn security_state(&self) -> Option<&SecurityState>

Get the security state (for advanced use).

pub fn object_count(&self) -> usize

Number of objects declared in xref.

pub fn catalog_ref(&self) -> Option<&IndirectRef>

The /Root (catalog) reference from the trailer.

pub fn trailer(&self) -> &PdfDict

Get the trailer dictionary.

pub fn resolve(&self, iref: &IndirectRef) -> Result<PdfObject>

Resolve an indirect reference to the actual object. Uses internal LRU cache. Detects circular references. Automatically decrypts if the document is encrypted and authenticated.

Returns a cloned PdfObject (owned). The interior LRU cache is protected by a RwLock, so this method only requires &self and can be called from multiple threads simultaneously.

pub fn object_refs(&self) -> impl Iterator<Item = IndirectRef> + '_

Iterate over all in-use object references.

pub fn decode_stream(&self, dict: &PdfDict, raw_data: &[u8]) -> Result<Vec<u8>>

Decode a stream object’s data.

pub fn raw_data(&self) -> &[u8]

Get the raw file data.

pub fn set_cache_capacity(&mut self, capacity: usize)

Set the maximum number of parsed objects to keep in the LRU cache.

pub fn cached_object_count(&self) -> usize

Return the current number of cached objects.

impl PdfDocument

pub fn from_bytes_with_repair(data: Vec<u8>) -> Result<Self>

Parse a PDF from bytes, falling back to xref repair if the normal cross-reference table or trailer is damaged.

This tries PdfDocument::from_bytes first. If that fails the file is scanned for object definitions and a synthetic xref is built via rebuild_xref.

Trait Implementations

impl Debug for PdfDocument

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

Formats the value using the given formatter.