Struct PageEdit 

pub struct PageEdit { /* private fields */ }

One page’s object graph, opened for editing.

Obtained from the facade’s Page::edit. Holds the objects the page draws, in painting order, plus a record of what has changed — which is what tells the save which content streams to write again and which to leave alone.

Nothing is mutated until you save

Page::edit hands back an owned graph, you change that, and Document::save_pages turns the changes into replacement objects on the way out. The document is never touched, which is why editing a page needs no &mut Document and why two threads can edit two pages at once.

Saving an edited page rewrites it, and rewriting loses things

A page whose objects you changed is written again from the object graph, not patched. Only rg/RG colours survive, so a CMYK or ICC-based fill comes back black; patterns, shadings and Type 3 text are lost; text keeps only its matrix, font, render mode and strings, so character and word spacing go. The pdfrum-edit documentation lists them in full. This applies only to pages you edited — every other page is copied through byte-for-byte.

use pdfrum::{Document, SaveOptions};

let doc = Document::open("in.pdf")?;
let mut page = doc.page(0)?.edit();
page.remove(0);
doc.save_pages("out.pdf", &[page], &SaveOptions::default())?;

Implementations

impl PageEdit

pub fn new(index: PageIndex, page: Page) -> Self

An editable graph for the page at index.

pub fn len(&self) -> usize

How many objects the page draws, including any switched off with PageEdit::hide.

pub fn is_empty(&self) -> bool

Whether the page draws nothing at all.

pub fn index(&self) -> PageIndex

The zero-based index of the page being edited.

pub fn objects(&self) -> &[PageObject]

The objects, in painting order.

pub fn object_mut(&mut self, index: usize) -> Option<&mut PageObject>

The object at index, for a caller who wants to change it in place.

Taking this reference is the edit — the object is marked changed on the way out, so its content stream is rewritten whether or not you go on to touch it. Read with PageEdit::objects when you only want to look.

pub fn push(&mut self, object: PageObject)

Append an object, drawn last and therefore on top.

pub fn insert( &mut self, index: usize, object: PageObject, ) -> Result<(), IndexOutOfRange>

Insert an object at index, pushing the ones there and after later in the painting order. An index equal to PageEdit::len appends.

Errors

IndexOutOfRange when index is past the end.

pub fn remove(&mut self, index: usize) -> Option<PageObject>

Remove the object at index and hand it back.

pub fn show(&mut self, index: usize) -> Result<(), IndexOutOfRange>

Show the object at index without removing it.

A hidden object keeps its place and its index, so it can be shown again — but it contributes nothing to the saved page, and reloading the saved file will not find it.

Errors

IndexOutOfRange when there is no object at index.

pub fn hide(&mut self, index: usize) -> Result<(), IndexOutOfRange>

Hide the object at index without removing it.

See PageEdit::show.

Errors

IndexOutOfRange when there is no object at index.

pub fn is_visible(&self, index: usize) -> Option<bool>

Whether the object at index is drawn.

pub fn transform( &mut self, index: usize, transform: Affine, ) -> Result<(), IndexOutOfRange>

Move the object at index by transform.

The transform is applied before the object’s existing one, so Affine::translate((10.0, 0.0)) moves it ten points right in page space whatever it was already doing.

Errors

IndexOutOfRange when there is no object at index.

pub fn is_modified(&self) -> bool

Whether anything has been changed since the page was opened.

A false here means the save will not rewrite this page’s content at all, and its bytes will come through untouched.

pub fn graph(&self) -> &Page

Escape hatch — requires pdfrum-page. The object graph underneath, for a caller reaching past this surface.

Matches the facade’s Page::objects and Document::parser.

pub fn graph_mut(&mut self) -> &mut Page

Escape hatch — requires pdfrum-page. The graph, mutably.

Marks nothing: a caller reaching here is responsible for saying what it changed.

impl PageEdit

pub fn font_of(&self, index: usize) -> Option<ObjRef>

The /Font resource the text object at index uses, for a TextBuilder that wants to write in the same font.

None when there is no such object, when it is not text, or when its font was written inline in the resource dictionary and so has no object to name.

pub fn image_of(&self, index: usize) -> Option<ObjRef>

The image XObject the object at index draws, for an ImageBuilder that wants to place the same image again.

None for anything that is not an image, and for an inline image, which has no indirect object to name.

Trait Implementations

impl Clone for PageEdit

fn clone(&self) -> PageEdit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageEdit

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

Formats the value using the given formatter.