Skip to content
PDF Oxide

编辑概览

PDF Oxide 提供两个级别的 API 来编辑现有 PDF：高级 Pdf 类（推荐）和底层 DocumentEditor。两者都允许你打开 PDF、修改内容和元数据、跟踪变更并保存结果。

打开 PDF 进行编辑

Python

from pdf_oxide import PdfDocument

doc = PdfDocument("input.pdf")

编辑器在首次修改时延迟初始化。你可以立即开始读取，编辑器在你调用任何修改方法（如 set_title() 或 page()）时激活。

WASM

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

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

Rust

使用统一的 Pdf API：

use pdf_oxide::api::Pdf;

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

或直接使用 DocumentEditor 进行底层控制：

use pdf_oxide::editor::DocumentEditor;

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

检查修改

在保存之前，你可以检查是否有任何更改：

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

保存

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

save() 方法默认执行 PDF 的完整重写。对于高级保存选项（增量更新、加密），参见加密与安全。

文档元数据

读取和写入标准 PDF 元数据字段：标题、作者、主题和关键词。

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

文档信息

源路径和版本

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

完整 API 参考

DocumentEditor

方法 返回值 描述
open(path) Result<DocumentEditor> 打开 PDF 进行编辑
is_modified() bool 检查是否有任何更改
source_path() &str 源 PDF 的路径
source() &PdfDocument 对源文档的只读访问
version() (u8, u8) PDF version (major, minor)
current_page_count() usize 文档中的页数
title() Result<Option<String>> 获取文档标题
set_title(title) () 设置文档标题
author() Result<Option<String>> 获取文档作者
set_author(author) () 设置文档作者
subject() Result<Option<String>> 获取文档主题
set_subject(subject) () 设置文档主题
keywords() Result<Option<String>> 获取文档关键词
set_keywords(keywords) () 设置文档关键词
save(path) Result<()> 完整重写保存
save_with_options(path, options) Result<()> 使用自定义选项保存

Pdf（统一 API）

方法 返回值 描述
Pdf::open(path) Result<Pdf> 打开 PDF 进行编辑
Pdf::open_editor(path) Result<DocumentEditor> Open directly as DocumentEditor
is_modified() bool 检查是否有更改
save(path) Result<()> 保存文档
save_as(path) Result<()> 保存到新路径
page(index) Result<PdfPage> 获取用于 DOM 编辑的页面
save_page(page) Result<()> 保存修改后的页面
editor() Option<&mut DocumentEditor> 访问底层编辑器

EditableDocument trait

EditableDocument trait 定义了核心编辑契约：

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

完整编辑工作流

此示例演示了完整的编辑会话：打开、检查、修改元数据、编辑内容和保存。

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

相关页面