Struct PdfWriter 

pub struct PdfWriter { /* private fields */ }

PDF document writer.

Builds a complete PDF document with pages, fonts, and content.

Implementations

impl PdfWriter

pub fn new() -> Self

Create a new PDF writer with default config.

pub fn with_config(config: PdfWriterConfig) -> Self

Create a PDF writer with custom config.

pub fn set_outline(&mut self, outline: OutlineBuilder)

Attach a document outline (bookmarks) to be emitted during PdfWriter::finish. Replaces any previously-set outline.

pub fn set_page_labels(&mut self, labels: PageLabelsBuilder)

Attach a /PageLabels number-tree (Roman numeral preface → Arabic body etc.) to be emitted during finish.

pub fn register_embedded_font(&mut self, font: EmbeddedFont) -> String

Register an embedded TrueType font for use in content streams.

Returns the resource name (e.g. "EF1") that add_embedded_text should use. The font is consumed; finish() emits its five PDF objects (Type 0 / CIDFontType2 / FontDescriptor / FontFile2 stream / ToUnicode CMap stream — ISO 32000-1 §9.6.4 / §9.7.4 / §9.8 / §9.9 / §9.10.2).

The font’s display name (used in PostScript/BaseFont fields) is taken from EmbeddedFont::name. Callers wanting a stable subset tag should track the resource name they get back and reuse it.

pub fn register_embedded_font_as( &mut self, user_name: impl Into<String>, font: EmbeddedFont, ) -> String

Register an embedded TrueType font under a user-visible name (e.g. "NotoSansCJKtc"). The name is what callers pass to FluentPageBuilder::font(name, size) / FontSpec::name; when a ContentElement::Text is dispatched, the PageBuilder looks up this map and routes matching elements through add_embedded_text (hex-encoded Type-0 emission) instead of the base-14 map_font_name fallback that silently collapses unknown names to Helvetica.

Returns the EFn resource name for callers that want to mix low-level add_embedded_text calls with the high-level path.

pub fn add_page(&mut self, width: f32, height: f32) -> PageBuilder<'_>

Add a page with the given dimensions.

pub fn add_letter_page(&mut self) -> PageBuilder<'_>

Add a US Letter sized page (8.5“ x 11“).

pub fn add_a4_page(&mut self) -> PageBuilder<'_>

Add an A4 sized page (210mm x 297mm).

pub fn finish(self) -> Result<Vec<u8>>

Build the complete PDF document.

pub fn save(self, path: impl AsRef<Path>) -> Result<()>

Save the PDF to a file.

Trait Implementations

impl Default for PdfWriter

fn default() -> Self

Returns the “default value” for a type.