Struct ObjectStore 

pub struct ObjectStore<S: PdfSource = Arc<[u8]>> { /* private fields */ }

The central PDF object store with thread-safe lazy parsing.

Generic over the source data type via PdfSource.

Implementations

impl<S: PdfSource> ObjectStore<S>

pub fn open(source: S, mode: ParsingMode) -> Result<Self, PdfError>

Open a PDF source, parsing the header, xref table, and trailer.

This constructs the ObjectStore with all object slots ready for lazy parsing on demand. For encrypted PDFs, use Self::open_with_password.

pub fn open_with_password( source: S, mode: ParsingMode, password: Option<&str>, ) -> Result<Self, PdfError>

Open a PDF source, optionally providing a password for encrypted documents.

After parsing the header, xref, and trailer, if the trailer contains an /Encrypt entry, the encryption dictionary is resolved and a SecurityHandler is created. The password is verified against both user and owner password hashes.

pub fn resolve(&self, id: ObjectId) -> Result<&Object, PdfError>

Resolve an indirect object by its ID. Returns a reference to the lazily-parsed object.

pub fn deep_resolve<'a>( &'a self, obj: &'a Object, ) -> Result<&'a Object, PdfError>

Follow a reference chain to the concrete object.

Uses an iterative loop with circular reference detection via SmallVec. Never recurses on the call stack.

pub fn dict_resolve<'a>( &'a self, dict: &'a HashMap<Name, Object>, key: &Name, ) -> Result<Option<&'a Object>, PdfError>

Resolve a dictionary value by key, following references.

pub fn decode_stream(&self, stream: &Object) -> Result<Vec<u8>, PdfError>

Decode stream data on demand using the filter chain from the stream dictionary.

Resolves /Filter and /DecodeParms from the stream dictionary, then applies the codec pipeline via rpdfium_codec::apply_filter_chain.

pub fn parsing_mode(&self) -> ParsingMode

Get the parsing mode.

pub fn trailer(&self) -> &TrailerInfo

Get the trailer info.

pub fn version(&self) -> PdfVersion

Get the PDF version from the header.

pub fn xref(&self) -> &XrefTable

Get the cross-reference table.

pub fn object_count(&self) -> usize

Get the number of object slots.

pub fn contains(&self, id: ObjectId) -> bool

Check if an object ID exists in the store.

pub fn object_ids(&self) -> impl Iterator<Item = &ObjectId>

Get all known object IDs.

pub fn security_handler(&self) -> Option<&SecurityHandler>

Returns a reference to the security handler, if the document is encrypted.

pub fn source_data(&self) -> &S

Returns a reference to the raw source data.

pub fn xref_start_offset(&self) -> u64

Returns the byte offset of the last startxref value.

This is needed for incremental saves to set the /Prev trailer key.

pub fn max_object_number(&self) -> u32

Returns the maximum object number in the store.

pub fn decode_stream_for_object( &self, stream: &Object, obj_id: ObjectId, ) -> Result<Vec<u8>, PdfError>

Decode stream data for a specific object, applying decryption if needed.

Like Self::decode_stream, but also decrypts the raw stream data before applying the filter chain when the document is encrypted.

pub fn raw_stream_bytes_for_object( &self, stream: &Object, obj_id: ObjectId, ) -> Result<Vec<u8>, PdfError>

Return the raw (optionally decrypted) stream bytes without applying any filter chain. This is useful when the caller needs to handle a specific filter (like JPXDecode) specially to extract metadata.

pub fn decrypt_string(&self, data: &[u8], obj_id: ObjectId) -> Vec<u8>

Decrypt a string value from an encrypted document.

If the document is not encrypted, returns the input bytes unchanged.