Struct lopdf::Document

pub struct Document {
    pub version: String,
    pub trailer: Dictionary,
    pub reference_table: Xref,
    pub objects: BTreeMap<ObjectId, Object>,
    pub max_id: u32,
}

PDF document.

Fields

version: String

The version of the PDF specification to which the file conforms.

trailer: Dictionary

The trailer gives the location of the cross-reference table and of certain special objects.

reference_table: Xref

The cross-reference table contains locations of the indirect objects.

objects: BTreeMap<ObjectId, Object>

The objects that make up the document contained in the file.

max_id: u32

Current maximum object id within the document.

Methods

impl Document

pub fn new() -> Document

Create new PDF document.

pub fn dereference<'a>(
    &'a self,
    object: &'a Object
) -> Result<(Option<ObjectId>, &'a Object)>

Follow references if the supplied object is a reference.

Returns a tuple of an optional object id and final object. The object id will be None if the object was not a reference. Otherwise, it will be the last object id in the reference chain.

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

Get object by object id, will iteratively dereference a referenced object.

pub fn get_object_mut(&mut self, id: ObjectId) -> Result<&mut Object>

Get mutable reference to object by object id, will iteratively dereference a referenced object.

pub fn get_dictionary(&self, id: ObjectId) -> Result<&Dictionary>

Get dictionary object by id.

pub fn traverse_objects<A: Fn(&mut Object)>(
    &mut self,
    action: A
) -> Vec<ObjectId>

Traverse objects from trailer recursively, return all referenced object IDs.

pub fn catalog(&self) -> Result<&Dictionary>

Get catalog dictionary.

pub fn get_pages(&self) -> BTreeMap<u32, ObjectId>

Get page numbers and corresponding object ids.

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

pub fn get_page_contents(&self, page_id: ObjectId) -> Vec<ObjectId>

Get content stream object ids of a page.

pub fn get_page_content(&self, page_id: ObjectId) -> Result<Vec<u8>>

Get content of a page.

pub fn get_and_decode_page_content(&self, page_id: ObjectId) -> Result<Content>

Get decoded page content;

pub fn get_page_resources(
    &self,
    page_id: ObjectId
) -> (Option<&Dictionary>, Vec<ObjectId>)

Get resources used by a page.

pub fn get_page_fonts(
    &self,
    page_id: ObjectId
) -> BTreeMap<Vec<u8>, &Dictionary>

Get fonts used by a page.

pub fn decode_text(encoding: Option<&str>, bytes: &[u8]) -> String

pub fn encode_text(encoding: Option<&str>, text: &str) -> Vec<u8>

impl Document

pub fn with_version<S: Into<String>>(version: S) -> Document

Create new PDF document with version.

pub fn new_object_id(&mut self) -> ObjectId

Create an object ID.

pub fn add_object<T: Into<Object>>(&mut self, object: T) -> ObjectId

Add PDF object into document's object list.

pub fn get_or_create_resources(
    &mut self,
    page_id: ObjectId
) -> Result<&mut Object>

pub fn add_xobject<N: Into<Vec<u8>>>(
    &mut self,
    page_id: ObjectId,
    xobject_name: N,
    xobject_id: ObjectId
) -> Result<()>

pub fn add_graphics_state<N: Into<Vec<u8>>>(
    &mut self,
    page_id: ObjectId,
    gs_name: N,
    gs_id: ObjectId
) -> Result<()>

impl Document

pub fn change_producer(&mut self, producer: &str)

Change producer of document information dictionary.

pub fn compress(&mut self)

Compress PDF stream objects.

pub fn decompress(&mut self)

Decompress PDF stream objects.

pub fn delete_pages(&mut self, page_numbers: &[u32])

Delete pages.

pub fn prune_objects(&mut self) -> Vec<ObjectId>

Prune all unused objects.

pub fn delete_object(&mut self, id: ObjectId) -> Option<Object>

Delete object by object ID.

pub fn delete_zero_length_streams(&mut self) -> Vec<ObjectId>

Delete zero length stream objects.

pub fn renumber_objects(&mut self)

Renumber objects, normally called after delete_unused_objects.

pub fn extract_text(&self, page_numbers: &[u32]) -> Result<String>

pub fn change_content_stream(&mut self, stream_id: ObjectId, content: Vec<u8>)

pub fn change_page_content(
    &mut self,
    page_id: ObjectId,
    content: Vec<u8>
) -> Result<()>

pub fn replace_text(
    &mut self,
    page_number: u32,
    text: &str,
    other_text: &str
) -> Result<()>

pub fn extract_stream(
    &self,
    stream_id: ObjectId,
    decompress: bool
) -> Result<()>

impl Document

pub fn load<P: AsRef<Path>>(path: P) -> Result<Document>

Load a PDF document from a specified file path.

pub fn load_from<R: Read>(source: R) -> Result<Document>

Load a PDF document from an arbitrary source.

pub fn load_mem(buffer: &[u8]) -> Result<Document>

Load a PDF document from a memory slice.

impl Document

pub fn save<P: AsRef<Path>>(&mut self, path: P) -> Result<File>

Save PDF document to specified file path.

pub fn save_to<W: Write>(&mut self, target: &mut W) -> Result<()>

Save PDF to arbitrary target

impl Document

pub fn insert_form_object(
    &mut self,
    page_id: ObjectId,
    form_obj: Stream
) -> Result<()>

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Document

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Document

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

Formats the value using the given formatter.

impl<'_> TryInto<Document> for &'_ [u8]

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Document>

Performs the conversion.