Skip to content
PDF Oxide

Visão Geral de Edição

O PDF Oxide fornece dois níveis de API para edição de PDFs existentes: a classe de alto nível Pdf (recomendada) e o DocumentEditor de nível inferior. Ambos permitem abrir um PDF, modificar seu conteúdo e metadados, rastrear alterações e salvar o resultado.

Abrindo um PDF para Edição

Python

from pdf_oxide import PdfDocument

doc = PdfDocument("input.pdf")

O editor é inicializado de forma lazy na primeira modificação. Você pode começar a ler imediatamente e o editor é ativado when you call any mutating método such as set_title() or page().

WASM

import { WasmPdfDocument } from "pdf-oxide-wasm";

const bytes = new Uint8Array(/* file bytes */);
const doc = new WasmPdfDocument(bytes);

Rust

Use the unified Pdf API:

use pdf_oxide::api::Pdf;

let mut doc = Pdf::open("input.pdf")?;

Ou use DocumentEditor diretamente para controle de nível inferior:

use pdf_oxide::editor::DocumentEditor;

let mut editor = DocumentEditor::open("input.pdf")?;

Verificando Modificações

Antes de salvar, voce pode verificar se alguma alteracao foi feita:

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());

Salvando

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")?;

O método save() realiza uma reescrita completa do PDF por padrão. Para opções avançadas de salvamento (atualizações incrementais, criptografia), veja Criptografia & Security.

Metadados do Documento

Read and write the standard PDF metadata fields: title, author, subject, and keywords.

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")?;

Informacoes do Documento

Source Path and Version

use pdf_oxide::editor::DocumentEditor;

let editor = DocumentEditor::open("input.pdf")?;

// Path to the original file
println!("Source: {}", editor.source_path());

// Versão do PDF as (major, minor)
let (major, minor) = editor.version();
println!("Versão do PDF: {}.{}", major, minor);

// Número de páginas
println!("Pages: {}", editor.current_page_count());

Referência Completa da API

DocumentEditor

Method Retorna Descrição
open(path) Result<DocumentEditor> Open a PDF for editing
is_modified() bool Check if any changes have been made
source_path() &str Path to the source PDF
source() &PdfDocument Read-only access to the source document
version() (u8, u8) Versão do PDF (major, minor)
current_page_count() usize Número de páginas no documento
title() Result<Option<String>> Get document title
set_title(title) () Definir título do documento
author() Result<Option<String>> Get document author
set_author(author) () Definir autor do documento
subject() Result<Option<String>> Get document subject
set_subject(subject) () Definir assunto do documento
keywords() Result<Option<String>> Get document keywords
set_keywords(keywords) () Definir palavras-chave do documento
save(path) Result<()> Save with full rewrite
save_with_options(path, options) Result<()> Save with custom options

Pdf (Unified API)

Method Retorna Descrição
Pdf::open(path) Result<Pdf> Open a PDF for editing
Pdf::open_editor(path) Result<DocumentEditor> Open directly as DocumentEditor
is_modified() bool Check if changes exist
save(path) Result<()> Save the document
save_as(path) Result<()> Save to a new path
page(index) Result<PdfPage> Get a página for DOM editing
save_page(page) Result<()> Save a modified página back
editor() Option<&mut DocumentEditor> Acessar o editor subjacente

EditableDocument Trait

A trait EditableDocument define o contrato principal de edição:

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<()>;
}

Fluxo de Edicao Completo

Este exemplo demonstra uma sessão completa de edição: abrir, inspecionar, modificar metadados, editar conteúdo e salvar.

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