Edición de PDF — Descripción general
PDF Oxide proporciona dos niveles de API para editar PDFs existentes: la clase de alto nivel Pdf (recomendada) y el DocumentEditor de nivel inferior. Ambos permiten abrir un PDF, modificar su contenido y metadatos, rastrear cambios y guardar el resultado.
Abrir un PDF para edición
Python
from pdf_oxide import PdfDocument
doc = PdfDocument("input.pdf")
El editor se inicializa bajo demanda en la primera modificación. Puedes comenzar a leer inmediatamente y el editor se activa cuando llamas a cualquier método de mutación como set_title() o page().
WASM
import { WasmPdfDocument } from "pdf-oxide-wasm";
const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);
Rust
Usa la API unificada Pdf:
use pdf_oxide::api::Pdf;
let mut doc = Pdf::open("input.pdf")?;
O usa DocumentEditor directamente para control de nivel inferior:
use pdf_oxide::editor::DocumentEditor;
let mut editor = DocumentEditor::open("input.pdf")?;
Verificar modificaciones
Antes de guardar, puedes verificar si se han realizado cambios:
Python
doc = PdfDocument("input.pdf")
print(doc.is_modified) # False -- no changes yet
doc.set_title("Updated Title")
print(doc.is_modified) # True
Rust
let mut doc = Pdf::open("input.pdf")?;
assert!(!doc.is_modified());
doc.editor().unwrap().set_title("Updated Title");
assert!(doc.is_modified());
Guardar
Python
doc = PdfDocument("input.pdf")
doc.set_title("New Title")
doc.save("output.pdf")
WASM
import { WasmPdfDocument } from "pdf-oxide-wasm";
const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);
doc.setTitle("New Title");
const output = doc.save();
doc.free();
Rust
let mut doc = Pdf::open("input.pdf")?;
doc.editor().unwrap().set_title("New Title");
doc.save("output.pdf")?;
// Or save to a new path
doc.save_as("copy.pdf")?;
El método save() realiza una reescritura completa del PDF por defecto. Para opciones avanzadas de guardado (actualizaciones incrementales, encriptación), consulta Encryption & Security.
Metadatos del documento
Lee y escribe los campos estándar de metadatos PDF: título, autor, asunto y palabras clave.
Python
from pdf_oxide import PdfDocument
doc = PdfDocument("input.pdf")
# Set metadata
doc.set_title("Quarterly Report")
doc.set_author("Jane Smith")
doc.set_subject("Q4 2025 Financial Results")
doc.set_keywords("finance, quarterly, 2025")
doc.save("output.pdf")
WASM
import { WasmPdfDocument } from "pdf-oxide-wasm";
const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);
// Set metadata
doc.setTitle("Quarterly Report");
doc.setAuthor("Jane Smith");
doc.setSubject("Q4 2025 Financial Results");
doc.setKeywords("finance, quarterly, 2025");
const output = doc.save();
doc.free();
Rust
use pdf_oxide::editor::DocumentEditor;
let mut editor = DocumentEditor::open("input.pdf")?;
// Read metadata
if let Some(title) = editor.title()? {
println!("Current title: {}", title);
}
if let Some(author) = editor.author()? {
println!("Current author: {}", author);
}
if let Some(subject) = editor.subject()? {
println!("Current subject: {}", subject);
}
if let Some(keywords) = editor.keywords()? {
println!("Current keywords: {}", keywords);
}
// Set metadata
editor.set_title("Quarterly Report");
editor.set_author("Jane Smith");
editor.set_subject("Q4 2025 Financial Results");
editor.set_keywords("finance, quarterly, 2025");
editor.save("output.pdf")?;
Información del documento
Ruta de origen y versión
use pdf_oxide::editor::DocumentEditor;
let editor = DocumentEditor::open("input.pdf")?;
// Path to the original file
println!("Source: {}", editor.source_path());
// PDF version as (major, minor)
let (major, minor) = editor.version();
println!("PDF version: {}.{}", major, minor);
// Number of pages
println!("Pages: {}", editor.current_page_count());
Referencia completa de la API
DocumentEditor
| Método | Retorna | Descripción |
|---|---|---|
open(path) |
Result<DocumentEditor> |
Abrir un PDF para edición |
is_modified() |
bool |
Verificar si se han realizado cambios |
source_path() |
&str |
Ruta al PDF fuente |
source() |
&PdfDocument |
Acceso de solo lectura al documento fuente |
version() |
(u8, u8) |
Versión PDF (mayor, menor) |
current_page_count() |
usize |
Número de páginas en el documento |
title() |
Result<Option<String>> |
Obtener título del documento |
set_title(title) |
() |
Establecer título del documento |
author() |
Result<Option<String>> |
Obtener autor del documento |
set_author(author) |
() |
Establecer autor del documento |
subject() |
Result<Option<String>> |
Obtener asunto del documento |
set_subject(subject) |
() |
Establecer asunto del documento |
keywords() |
Result<Option<String>> |
Obtener palabras clave del documento |
set_keywords(keywords) |
() |
Establecer palabras clave del documento |
save(path) |
Result<()> |
Guardar con reescritura completa |
save_with_options(path, options) |
Result<()> |
Guardar con opciones personalizadas |
Pdf (Unified API)
| Método | Retorna | Descripción |
|---|---|---|
Pdf::open(path) |
Result<Pdf> |
Abrir un PDF para edición |
Pdf::open_editor(path) |
Result<DocumentEditor> |
Abrir directamente como DocumentEditor |
is_modified() |
bool |
Verificar si existen cambios |
save(path) |
Result<()> |
Guardar el documento |
save_as(path) |
Result<()> |
Guardar en una nueva ruta |
page(index) |
Result<PdfPage> |
Obtener una página para edición DOM |
save_page(page) |
Result<()> |
Guardar una página modificada de vuelta |
editor() |
Option<&mut DocumentEditor> |
Acceder al editor subyacente |
EditableDocument Trait
El trait EditableDocument define el contrato central de edición:
pub trait EditableDocument {
fn get_info(&mut self) -> Result<DocumentInfo>;
fn set_info(&mut self, info: DocumentInfo) -> Result<()>;
fn page_count(&mut self) -> Result<usize>;
fn get_page_info(&mut self, index: usize) -> Result<PageInfo>;
fn remove_page(&mut self, index: usize) -> Result<()>;
fn move_page(&mut self, from: usize, to: usize) -> Result<()>;
fn duplicate_page(&mut self, index: usize) -> Result<usize>;
fn save(&mut self, path: impl AsRef<Path>) -> Result<()>;
fn save_with_options(&mut self, path: impl AsRef<Path>, options: SaveOptions) -> Result<()>;
}
Flujo de trabajo de edición completo
Este ejemplo demuestra una sesión de edición completa: abrir, inspeccionar, modificar metadatos, editar contenido y guardar.
Python
from pdf_oxide import PdfDocument
# Open the document
doc = PdfDocument("report.pdf")
print(f"Pages: {doc.page_count()}")
# Update metadata
doc.set_title("Annual Report 2025")
doc.set_author("Finance Team")
# Edit text on page 0
page = doc.page(0)
for text in page.find_text_containing("DRAFT"):
page.set_text(text.id, "FINAL")
doc.save_page(page)
# Save
doc.save("report-final.pdf")
Rust
use pdf_oxide::api::Pdf;
let mut doc = Pdf::open("report.pdf")?;
println!("Pages: {}", doc.page_count()?);
// Update metadata
{
let editor = doc.editor().unwrap();
editor.set_title("Annual Report 2025");
editor.set_author("Finance Team");
}
// Edit text on page 0
let mut page = doc.page(0)?;
let drafts = page.find_text_containing("DRAFT");
for t in &drafts {
page.set_text(t.id(), "FINAL")?;
}
doc.save_page(page)?;
// Save
doc.save("report-final.pdf")?;
Páginas relacionadas
- Text Editing – buscar y reemplazar texto, modificar fuentes y posicionamiento
- Page Operations – rotación, recorte, combinación y extracción de páginas
- Form Field Editing – llenar, agregar y aplanar campos de formulario
- Encryption & Security – proteger con contraseña y establecer permisos