Skip to content
PDF Oxide

PdfBuilder フルーエント API

PdfBuilder は PDF 生成のためのフルーエントな設定 API を提供します。メソッドをチェーンしてページサイズ、余白、フォントサイズ、メタデータなどを設定し、from_* メソッドを呼び出して PDF を生成します。

バインディング対応状況。 フルーエントな PdfBuilder / WasmPdfBuilder は Python、Rust、WASM で公開されています。Go と C# のバインディングはショートカットのエントリポイント（FromMarkdown、FromHtml、FromImage / Pdf.FromMarkdown、Pdf.FromHtml、Pdf.FromText）を公開していますが、ビルダーの設定機能は公開していません。Go や C# からカスタム余白やページサイズを指定するには、フラグ付きで Rust CLI を呼び出すか、ビルダーを FFI 経由で公開する Rust ヘルパーをラップしてください。

クイック例

Python

from pdf_oxide import Pdf

# Python uses optional keyword arguments on Pdf static methods
pdf = Pdf.from_markdown(
    "# Report\n\nContent here.",
    title="Quarterly Report",
    author="Finance Team"
)
pdf.save("report.pdf")

WASM

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

// JavaScript uses optional title and author parameters
const pdf = WasmPdf.fromMarkdown(
  "# Report\n\nContent here.",
  "Quarterly Report",
  "Finance Team"
);
writeFileSync("report.pdf", pdf.toBytes());

Rust

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

let pdf = PdfBuilder::new()
    .title("Quarterly Report")
    .author("Finance Team")
    .page_size(PageSize::A4)
    .margin(54.0)
    .font_size(11.0)
    .line_height(1.5)
    .from_markdown("# Report\n\nContent here.")?;

pdf.save("report.pdf")?;

完全な API リファレンス

コンストラクタ

PdfBuilder::new() -> PdfBuilder

デフォルト設定で新しいビルダーを作成します:

設定 デフォルト
ページサイズ Letter (8.5" x 11")
すべての余白 72pt (1 インチ)
フォントサイズ 12pt
行の高さ 1.5

メタデータメソッド

.title(title) – ドキュメントタイトルを設定

PdfBuilder::new().title("My Document")

.author(author) – ドキュメントの作成者を設定

PdfBuilder::new().author("Jane Smith")

.subject(subject) – ドキュメントのサブジェクトを設定

PdfBuilder::new().subject("Annual Performance Review")

.keywords(keywords) – ドキュメントのキーワードを設定

PdfBuilder::new().keywords("report, annual, 2025")

レイアウトメソッド

.page_size(size) – ページサイズを設定

use pdf_oxide::writer::PageSize;

PdfBuilder::new().page_size(PageSize::A4)

PageSize 列挙型:

バリアント 寸法
PageSize::Letter 612 x 792 pt (8.5" x 11")
PageSize::A4 595 x 842 pt (210 x 297 mm)
PageSize::Legal 612 x 1008 pt (8.5" x 14")
PageSize::A3 842 x 1190 pt (297 x 420 mm)
PageSize::Custom(w, h) カスタム幅 x 高さ（ポイント単位）

.margin(margin) – 均一な余白を設定

4 辺すべての余白（左、右、上、下）を同じ値（ポイント単位）に設定します。

PdfBuilder::new().margin(54.0)  // 0.75 inch margins

.margins(left, right, top, bottom) – 個別の余白を設定

PdfBuilder::new().margins(72.0, 72.0, 54.0, 54.0)

タイポグラフィメソッド

.font_size(size) – デフォルトのフォントサイズを設定

PdfBuilder::new().font_size(11.0)

.line_height(height) – 行の高さの倍率を設定

行間のスペースを制御します。値が 1.5 の場合、フォントサイズの 1.5 倍を意味します。

PdfBuilder::new().line_height(1.6)

生成メソッド

各生成メソッドはビルダーを消費し、Pdf オブジェクトを返します。

.from_markdown(content) – Markdown から生成

let pdf = PdfBuilder::new()
    .title("Notes")
    .from_markdown("# Notes\n\n- Item one\n- Item two")?;

.from_html(content) – HTML から生成

let pdf = PdfBuilder::new()
    .title("Report")
    .from_html("<h1>Report</h1><p>Summary of findings.</p>")?;

.from_text(content) – プレーンテキストから生成

let pdf = PdfBuilder::new()
    .font_size(10.0)
    .from_text("Line 1\nLine 2\nLine 3")?;

.from_image(path) – 単一の画像から生成

let pdf = PdfBuilder::new()
    .page_size(PageSize::A4)
    .from_image("photo.jpg")?;

.from_image_bytes(data) – 画像バイトから生成

let data = std::fs::read("chart.png")?;
let pdf = PdfBuilder::new().from_image_bytes(&data)?;

.from_images(paths) – 複数の画像から生成

let pdf = PdfBuilder::new()
    .title("Photo Album")
    .from_images(&["img1.jpg", "img2.jpg", "img3.jpg"])?;

.from_qrcode(data) – QR コード PDF を生成

barcodes フィーチャーが必要です。

let pdf = PdfBuilder::new()
    .title("QR Code")
    .from_qrcode("https://example.com")?;

.from_barcode(barcode_type, data) – バーコード PDF を生成

barcodes フィーチャーが必要です。

use pdf_oxide::writer::barcode::BarcodeType;

let pdf = PdfBuilder::new()
    .from_barcode(BarcodeType::Code128, "ABC-12345")?;

応用例

完全な設定チェーン

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

let content = r#"
# Technical Specification

## Overview

This document defines the interface contract for the v2 API.

## Endpoints

- `GET /api/v2/users` - List users
- `POST /api/v2/users` - Create user
- `GET /api/v2/users/:id` - Get user by ID

## Authentication

All endpoints require a Bearer token in the Authorization header.
"#;

let pdf = PdfBuilder::new()
    .title("API Specification v2")
    .author("Platform Team")
    .subject("REST API Technical Specification")
    .keywords("api, rest, specification, v2")
    .page_size(PageSize::A4)
    .margins(72.0, 72.0, 54.0, 72.0)
    .font_size(11.0)
    .line_height(1.5)
    .from_markdown(content)?;

pdf.save("api_spec.pdf")?;

カスタムページサイズ

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

// Create a half-letter page (5.5" x 8.5")
let pdf = PdfBuilder::new()
    .page_size(PageSize::Custom(396.0, 612.0))
    .margin(36.0)
    .font_size(10.0)
    .from_markdown("# Pocket Guide\n\nCompact reference card.")?;

pdf.save("pocket_guide.pdf")?;

JavaScript の同等機能

JavaScript/WASM では、WasmPdf の静的メソッドはオプションの title および author パラメータを受け取り、PdfBuilder のメタデータと同じ機能を提供します:

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

const pdf = WasmPdf.fromMarkdown("# Notes\n\n- Item one\n- Item two", "Notes");
const html = WasmPdf.fromHtml("<h1>Report</h1><p>Summary.</p>", "Report", "Author");
const text = WasmPdf.fromText("Line 1\nLine 2", "Plain Text Doc");
const img = WasmPdf.fromImageBytes(imageData);

ページサイズ、余白、フォントサイズ、行の高さの設定は WASM API では利用できません。デフォルトのレイアウト設定を使用してください。

出力メソッド

Pdf / WasmPdf オブジェクトを取得したら、以下のメソッドを使って出力します:

メソッド 言語 説明
.save(path) Python, Rust PDF をファイルに書き込む
.to_bytes() (Python) Python 生の PDF バイトを取得する
.into_bytes() (Rust) Rust Pdf を消費して Vec<u8> を返す
.toBytes() (JS) JavaScript PDF を Uint8Array として取得する

関連ページ