Skip to main content

DocumentModifier

Struct DocumentModifier 

Source
pub struct DocumentModifier { /* private fields */ }
Expand description

Modifier for existing PDF documents. Loads all objects from a PdfDocument, allows modification, then saves.

Implementations§

Source§

impl DocumentModifier

Source

pub fn from_document(doc: &PdfDocument) -> Result<Self>

Create a modifier from an existing PdfDocument. Copies all objects from the document into the writer.

Source

pub fn writer(&mut self) -> &mut PdfWriter

Get a reference to the internal writer for low-level modifications.

Source

pub fn catalog_ref(&self) -> &IndirectRef

Get the catalog reference.

Source

pub fn set_object(&mut self, obj_num: u32, obj: PdfObject)

Replace an object at a given object number.

Source

pub fn add_object(&mut self, obj: PdfObject) -> IndirectRef

Add a new object and return its reference.

Source

pub fn find_object_pub(&self, obj_num: u32) -> Option<&PdfObject>

Find an object by object number (public accessor).

Source

pub fn delete_page(&mut self, page_index: usize) -> Result<()>

Delete a page by index (0-based). Modifies the Pages tree to remove the page reference.

Source

pub fn insert_page( &mut self, page_index: usize, page: PageBuilder, ) -> Result<()>

Insert a new page at the given index.

Source

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

Reorder pages. order is a list of 0-based page indices in the desired order.

Source

pub fn set_info(&mut self, key: &[u8], value: &str)

Set or update a metadata field in the Info dictionary.

Source

pub fn garbage_collect(&mut self)

Perform garbage collection: remove unreachable objects.

Traverses all objects reachable from the catalog (and info dict), then removes any objects that are not reachable.

Source

pub fn build(self) -> Result<Vec<u8>>

Serialize to PDF bytes.

Source

pub fn build_with_xref_stream( self, compressed: &[CompressedObjInfo], ) -> Result<Vec<u8>>

Serialize to PDF bytes using xref streams (PDF 1.5+). compressed contains info about objects packed into object streams.

Source

pub fn save(self, path: &Path) -> Result<()>

Save to file.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V