Struct PdfReader 

pub struct PdfReader<R: Read + Seek> { /* private fields */ }

High-level PDF reader

Implementations

impl<R: Read + Seek> PdfReader<R>

pub fn options(&self) -> &ParseOptions

Get parsing options

pub fn is_encrypted(&self) -> bool

Check if the PDF is encrypted

pub fn is_unlocked(&self) -> bool

Check if the PDF is unlocked (can read encrypted content)

pub fn encryption_handler_mut(&mut self) -> Option<&mut EncryptionHandler>

Get mutable access to encryption handler

pub fn encryption_handler(&self) -> Option<&EncryptionHandler>

Get access to encryption handler

pub fn unlock_with_password(&mut self, password: &str) -> ParseResult<bool>

Try to unlock PDF with password

pub fn try_empty_password(&mut self) -> ParseResult<bool>

Try to unlock with empty password

pub fn unlock(&mut self, password: &str) -> ParseResult<()>

Unlock encrypted PDF with password

Attempts to unlock the PDF using the provided password (tries both user and owner passwords). If the PDF is not encrypted, this method returns Ok(()) immediately.

Arguments

• password - User or owner password for the PDF

Errors

Returns ParseError::WrongPassword if the password is incorrect.

Example

use oxidize_pdf::parser::PdfReader;

let mut reader = PdfReader::open("encrypted.pdf")?;

if reader.is_encrypted() {
    reader.unlock("password")?;
}

let catalog = reader.catalog()?;

impl PdfReader<File>

pub fn open<P: AsRef<Path>>(path: P) -> ParseResult<Self>

Open a PDF file from a path

pub fn open_strict<P: AsRef<Path>>(path: P) -> ParseResult<Self>

Open a PDF file from a path with strict parsing

pub fn open_with_options<P: AsRef<Path>>( path: P, options: ParseOptions, ) -> ParseResult<Self>

Open a PDF file from a path with custom parsing options

pub fn open_document<P: AsRef<Path>>(path: P) -> ParseResult<PdfDocument<File>>

Open a PDF file as a PdfDocument

impl<R: Read + Seek> PdfReader<R>

pub fn new(reader: R) -> ParseResult<Self>

Create a new PDF reader from a reader

pub fn new_with_options(reader: R, options: ParseOptions) -> ParseResult<Self>

Create a new PDF reader with custom parsing options

pub fn version(&self) -> &PdfVersion

Get the PDF version

pub fn catalog(&mut self) -> ParseResult<&PdfDictionary>

Get the document catalog

pub fn info(&mut self) -> ParseResult<Option<&PdfDictionary>>

Get the document info dictionary

pub fn get_object( &mut self, obj_num: u32, gen_num: u16, ) -> ParseResult<&PdfObject>

Get an object by reference with circular reference protection

pub fn resolve<'a>( &'a mut self, obj: &'a PdfObject, ) -> ParseResult<&'a PdfObject>

Resolve a reference to get the actual object

pub fn resolve_stream_length( &mut self, obj: &PdfObject, ) -> ParseResult<Option<usize>>

Resolve a stream length reference to get the actual length value This is a specialized method for handling indirect references in stream Length fields

pub fn pages(&mut self) -> ParseResult<&PdfDictionary>

Get the page tree root

pub fn page_count(&mut self) -> ParseResult<u32>

Get the number of pages

pub fn metadata(&mut self) -> ParseResult<DocumentMetadata>

Get metadata from the document

pub fn get_page(&mut self, _index: u32) -> ParseResult<&ParsedPage>

Get a specific page by index (0-based)

Note: This method is currently not implemented due to borrow checker constraints. The page_tree needs mutable access to both itself and the reader, which requires a redesign of the architecture. Use PdfDocument instead for page access.

pub fn get_all_pages(&mut self) -> ParseResult<Vec<ParsedPage>>

Get all pages

pub fn into_document(self) -> PdfDocument<R>

Convert this reader into a PdfDocument for easier page access

pub fn clear_parse_context(&mut self)

Clear the parse context (useful to avoid false circular references)

pub fn parse_context_mut(&mut self) -> &mut StackSafeContext

Get a mutable reference to the parse context