Skip to content
PDF Oxide

編集の概要

PDF Oxide は既存 PDF を編集するための 2 段階の API を提供します。高レベルの 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 の完全な書き換えを実行します。高度な保存オプション（増分更新、暗号化）については Encryption & Security を参照してください。

Document Metadata

標準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バージョン as (major, minor)
let (major, minor) = editor.version();
println!("PDFバージョン: {}.{}", major, minor);

// ページ数
println!("Pages: {}", editor.current_page_count());

完全な API リファレンス

DocumentEditor

Method Returns 説明
open(path) Result<DocumentEditor> 編集用にPDFを開く
is_modified() bool 変更が行われたか確認
source_path() &str Path to the source PDF
source() &PdfDocument Read-only access to the source document
version() (u8, u8) PDFバージョン (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 (Unified API)

Method Returns 説明
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

The EditableDocument trait defines the core editing contract:

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

関連ページ