Skip to content
PDF Oxide

Текучий API PdfBuilder

PdfBuilder предоставляет текучий (fluent) API настройки для создания PDF. Объединяйте методы в цепочку, чтобы задать размер страницы, поля, размер шрифта, метаданные и многое другое, а затем вызовите метод from_* для генерации PDF.

Поддержка в привязках. Текучий PdfBuilder / WasmPdfBuilder доступен в Python, Rust и WASM. Привязки Go и C# предоставляют упрощённые точки входа (FromMarkdown, FromHtml, FromImage / Pdf.FromMarkdown, Pdf.FromHtml, Pdf.FromText), но не предоставляют интерфейс настройки билдера. Чтобы задать произвольные поля или размеры страницы из Go или C#, вызовите Rust CLI с нужными флагами или оберните вспомогательную функцию на Rust, которая предоставляет билдер через FFI.

Быстрый пример

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) – задать одинаковые поля

Задаёт все четыре поля (левое, правое, верхнее, нижнее) одинаковым значением в пунктах.

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) – создать PDF с QR-кодом

Требуется функция 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);

Настройка размера страницы, полей, размера шрифта и межстрочного интервала недоступна в API WASM — используйте параметры компоновки по умолчанию.

Методы вывода

Получив объект Pdf / WasmPdf, используйте эти методы для его вывода:

Метод Язык Описание
.save(path) Python, Rust Записать PDF в файл
.to_bytes() (Python) Python Получить сырые байты PDF
.into_bytes() (Rust) Rust Потребить Pdf и вернуть Vec<u8>
.toBytes() (JS) JavaScript Получить PDF в виде Uint8Array

Связанные страницы