Struct Document 

pub struct Document { /* private fields */ }

A document opened for reading.

Implementations

impl Document

pub fn open( source: impl Source + Send + Sync + 'static, options: OpenOptions, ) -> Result<Document, Error>

Opens a document from source.

pub fn open_shared( source: Arc<dyn Source + Sync + Send>, options: OpenOptions, ) -> Result<Document, Error>

Opens a document from a shared source.

pub fn file(&self) -> &File

The base file as read, without edits.

pub fn store(&self) -> &Store

The object store: the base file plus edits.

pub fn store_mut(&mut self) -> &mut Store

Mutable access to the store for low-level edits. Cached derived data (the page list) is dropped, since any edit may change it.

pub fn catalog_id(&self) -> Option<ObjId>

The catalog’s id, if it is an indirect object (it always is in a valid file).

pub fn catalog(&self) -> Dict

The document catalog, with edits.

pub fn version(&self) -> Option<Version>

The PDF version: the header’s, or the catalog’s /Version when that is later (§7.2.2).

pub fn diagnostics(&self) -> Vec<Diagnostic>

Repairs made while reading, so far.

pub fn is_encrypted(&self) -> bool

Whether the file is encrypted.

pub fn pages(&self) -> Result<Arc<Vec<Page>>, Error>

The pages, in order. Computed once.

pub fn page_count(&self) -> Result<usize, Error>

The number of pages.

pub fn info(&self) -> Info

The document information dictionary, decoded.

pub fn xmp_metadata(&self) -> Result<Option<Vec<u8>>, Error>

The catalog’s XMP metadata packet, decoded, if present.

pub fn outlines(&self) -> Result<Vec<OutlineItem>, Error>

The outline (bookmark) tree.

pub fn attachments(&self) -> Result<Vec<Attachment>, Error>

The embedded files listed in the /EmbeddedFiles name tree.

pub fn attachment_data(&self, attachment: &Attachment) -> Result<Vec<u8>, Error>

The decoded contents of an attachment.

impl Document

pub fn new() -> Result<Document, Error>

A new, empty document (one empty page tree, no pages).

pub fn select_pages(&mut self, indices: &[usize]) -> Result<(), Error>

Keeps the pages at indices (0-based), in that order. Pages left out are removed along with outline items and named destinations that point to them; a page listed twice is duplicated.

pub fn reorder_pages(&mut self, order: &[usize]) -> Result<(), Error>

Moves pages into order, a permutation of 0..page_count.

pub fn delete_pages(&mut self, indices: &[usize]) -> Result<(), Error>

Deletes the pages at indices, cleaning up outline items and named destinations that point to them.

pub fn rotate_page(&mut self, index: usize, degrees: i32) -> Result<(), Error>

Rotates a page clockwise by degrees (a multiple of 90) on top of its current rotation.

pub fn set_crop_box(&mut self, index: usize, rect: Rect) -> Result<(), Error>

Sets a page’s crop box (the visible region).

pub fn set_media_box(&mut self, index: usize, rect: Rect) -> Result<(), Error>

Sets a page’s media box (the physical page).

pub fn append_pages_from( &mut self, other: &Document, indices: Option<&[usize]>, ) -> Result<(), Error>

Appends pages of other (all of them when indices is None), copying every object they use. Objects shared by several imported pages are copied once.

pub fn extract_pages(&self, indices: &[usize]) -> Result<Document, Error>

A new document holding copies of the pages at indices.

pub fn named_destinations(&self) -> Result<Vec<(Vec<u8>, Object)>, Error>

Named destinations from /Dests (PDF 1.1) and the /Names /Dests name tree, keyed by name.

pub fn set_outlines(&mut self, items: &[OutlineItem]) -> Result<(), Error>

Replaces the outline tree with items (ids in the items are ignored; fresh objects are written). An empty list removes the outline.

pub fn set_info(&mut self, info: &Info) -> Result<(), Error>

Replaces the document information: fields that are None are removed, other entries of the Info dictionary are kept. The XMP packet is rewritten to match (D23).

pub fn add_attachment( &mut self, name: &str, data: &[u8], options: &AttachmentOptions, ) -> Result<(), Error>

Embeds data as an attachment named name, replacing one of the same name.

pub fn remove_attachment(&mut self, name: &str) -> Result<bool, Error>

Removes the attachment named name; returns whether it existed.

impl Document

pub fn sanitize( &mut self, options: &SanitizeOptions, ) -> Result<SanitizeReport, Error>

Removes the content selected by options and reports what went. Save in full afterwards: only a full save drops the removed objects from the file.

impl Document

pub fn save_to( &self, sink: &mut dyn Sink, options: &SaveOptions, ) -> Result<(), Error>

Saves the document into sink.

pub fn save(&self, options: &SaveOptions) -> Result<Vec<u8>, Error>

Saves the document and returns the bytes.

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.