Struct pdfium_render::document::PdfDocument

pub struct PdfDocument<'a> { /* private fields */ }

An entry point to all the various object collections contained in a single PDF file. These collections include:

• PdfDocument::attachments(), an immutable collection of all the PdfAttachments in the document.
• PdfDocument::attachments_mut(), a mutable collection of all the PdfAttachments in the document.
• PdfDocument::bookmarks(), an immutable collection of all the PdfBookmarks in the document.
• PdfDocument::form(), an immutable reference to the PdfForm embedded in the document, if any.
• PdfDocument::metadata(), an immutable collection of all the PdfMetadata tags in the document.
• PdfDocument::pages(), a collection of all the PdfPages in the document.
• PdfDocument::permissions(), settings relating to security handlers and document permissions for the document.
• PdfDocument::signatures(), an immutable collection of all the PdfSignatures in the document.

Implementations

impl<'a> PdfDocument<'a>

pub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings

Returns the PdfiumLibraryBindings used by this PdfDocument.

pub fn version(&self) -> PdfDocumentVersion

Returns the file version of this PdfDocument.

pub fn set_version(&mut self, version: PdfDocumentVersion)

Sets the file version that will be used the next time this PdfDocument is saved using the PdfDocument::save_to_writer() function.

pub fn attachments(&self) -> &PdfAttachments<'_>

Returns an immutable collection of all the PdfAttachments embedded in this PdfDocument.

pub fn attachments_mut(&mut self) -> &mut PdfAttachments<'a>

Returns a mutable collection of all the PdfAttachments embedded in this PdfDocument.

pub fn bookmarks(&self) -> &PdfBookmarks<'_>

Returns an immutable collection of all the PdfBookmarks in this PdfDocument.

pub fn form(&self) -> Option<&PdfForm<'a>>

Returns an immutable reference to the PdfForm embedded in this PdfDocument, if any.

pub fn metadata(&self) -> &PdfMetadata<'_>

Returns an immutable collection of all the PdfMetadata tags in this PdfDocument.

pub fn pages(&'a self) -> PdfPages<'a>

Returns a collection of all the PdfPages in this PdfDocument.

pub fn permissions(&self) -> &PdfPermissions<'_>

Returns an immutable collection of all the PdfPermissions applied to this PdfDocument.

pub fn signatures(&self) -> &PdfSignatures<'_>

Returns an immutable collection of all the PdfSignatures attached to this PdfDocument.

pub fn save_to_writer<W: Write + 'static>(
    &self,
    writer: &mut W
) -> Result<(), PdfiumError>

Writes this PdfDocument to the given writer.

pub fn save_to_file(
    &self,
    path: &impl AsRef<Path> + ?Sized
) -> Result<(), PdfiumError>

Writes this PdfDocument to the file at the given path.

This function is not available when compiling to WASM. You have several options for saving your PDF document data in WASM:

• Use either the PdfDocument::save_to_writer() or the PdfDocument::save_to_bytes() functions, both of which are available when compiling to WASM.
• Use the PdfDocument::save_to_blob() function to save document data directly into a new Javascript Blob object. This function is only available when compiling to WASM.

pub fn save_to_bytes(&self) -> Result<Vec<u8>, PdfiumError>

Writes this PdfDocument to a new byte buffer, returning the byte buffer.

Trait Implementations

impl<'a> Drop for PdfDocument<'a>

fn drop(&mut self)

Closes this PdfDocument, releasing held memory and, if the document was loaded from a file, the file handle on the document.