A step-by-step PDF writer.
toml
[dependencies]
pdf-writer = "0.6"
The entry point into the API is the main PdfWriter, 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.
The following example creates a PDF with a single, empty A4 page.
```rust use pdf_writer::{PdfWriter, Rect, Ref};
// Define some indirect reference ids we'll use. let catalogid = Ref::new(1); let pagetreeid = Ref::new(2); let pageid = Ref::new(3);
// Write a document catalog and a page tree with one A4 page that uses no resources. let mut writer = PdfWriter::new(); writer.catalog(catalogid).pages(pagetreeid); writer.pages(pagetreeid).kids([pageid]).count(1); writer.page(pageid) .parent(pagetreeid) .mediabox(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", writer.finish())?; ```
For more examples, check out the [examples folder] in the repository.
This crate forbids unsafe code, but it depends on a few popular crates that use unsafe internally.
This crate is dual-licensed under the MIT and Apache 2.0 licenses.