17 unstable releases (8 breaking)

0.9.3 Apr 17, 2024
0.9.2 Nov 1, 2023
0.9.1 Oct 24, 2023
0.7.1 May 3, 2023
0.3.1 Jul 14, 2021

#1 in #pdf-document

Download history 1536/week @ 2024-01-29 1948/week @ 2024-02-05 1524/week @ 2024-02-12 1847/week @ 2024-02-19 2036/week @ 2024-02-26 2064/week @ 2024-03-04 2705/week @ 2024-03-11 1743/week @ 2024-03-18 1374/week @ 2024-03-25 1455/week @ 2024-04-01 1197/week @ 2024-04-08 1348/week @ 2024-04-15 1205/week @ 2024-04-22 1532/week @ 2024-04-29 1088/week @ 2024-05-06 1392/week @ 2024-05-13

5,329 downloads per month
Used in 18 crates (7 directly)

MIT/Apache

360KB
6.5K SLoC

pdf-writer

Crates.io Documentation

A step-by-step PDF writer.

[dependencies]
pdf-writer = "0.9"

The entry point into the API is the main Pdf, which constructs the document into one big internal buffer. The top-level writer has many methods to create specialized writers for specific PDF objects. These all follow the same general pattern: They borrow the main buffer mutably, expose a builder pattern for writing individual fields in a strongly typed fashion and finish up the object when dropped.

There are a few more top-level structs with internal buffers, like the builder for Content streams, but wherever possible buffers are borrowed from parent writers to minimize allocations.

Minimal example

The following example creates a PDF with a single, empty A4 page.

use pdf_writer::{Pdf, Rect, Ref};

// Define some indirect reference ids we'll use.
let catalog_id = Ref::new(1);
let page_tree_id = Ref::new(2);
let page_id = Ref::new(3);

// Write a document catalog and a page tree with one A4 page that uses no resources.
let mut pdf = Pdf::new();
pdf.catalog(catalog_id).pages(page_tree_id);
pdf.pages(page_tree_id).kids([page_id]).count(1);
pdf.page(page_id)
    .parent(page_tree_id)
    .media_box(Rect::new(0.0, 0.0, 595.0, 842.0))
    .resources();

// Finish with cross-reference table and trailer and write to file.
std::fs::write("target/empty.pdf", pdf.finish())?;

For more examples, check out the examples folder in the repository.

Safety

This crate forbids unsafe code, but it depends on a few popular crates that use unsafe internally.

License

This crate is dual-licensed under the MIT and Apache 2.0 licenses.

Dependencies