Struct PdfBuilder 

pub struct PdfBuilder { /* private fields */ }

Fluent builder for generating PDFs.

All settings have sensible defaults — you can generate a PDF with just PdfBuilder::new().from_markdown(…). Customise anything you want via the chainable setter methods.

From Markdown

use pdfsmith::PdfBuilder;
let pdf = PdfBuilder::new()
    .from_markdown("# Hello")
    .unwrap();

From Markdown with custom CSS

use pdfsmith::PdfBuilder;
let pdf = PdfBuilder::new()
    .custom_css("body { font-family: Georgia; font-size: 12pt; }")
    .from_markdown("# Styled")
    .unwrap();

From JSON

use pdfsmith::PdfBuilder;
let json = serde_json::json!([
    { "type": "heading", "level": 1, "text": "Report" },
    { "type": "paragraph", "text": "Revenue grew **20%**." },
    { "type": "table", "headers": ["Q","Rev"], "rows": [["Q1","$1M"]] }
]);
let pdf = PdfBuilder::new()
    .from_json(&json)
    .unwrap();

Implementations

impl PdfBuilder

pub fn new() -> Self

New builder with default configuration.

pub fn with_config(config: PdfConfig) -> Self

New builder from an existing PdfConfig.

pub fn config(self, config: PdfConfig) -> Self

Replace the entire configuration.

pub fn title(self, title: impl Into<String>) -> Self

Set the document title (used in <title> and default header).

pub fn custom_css(self, css: impl Into<String>) -> Self

Replace the default CSS with your own stylesheet.

pub fn extra_css(self, css: impl Into<String>) -> Self

Append extra CSS after the base stylesheet.

pub fn paper_size(self, size: PaperSize) -> Self

Set paper size — A4, Letter, Legal, or Custom { width, height }.

pub fn margins(self, margins: PageMargins) -> Self

Set page margins (in inches).

pub fn landscape(self, yes: bool) -> Self

Enable landscape orientation.

pub fn header(self, header: HeaderConfig) -> Self

Configure the page header (left / center / right text, or custom HTML).

pub fn footer(self, footer: FooterConfig) -> Self

Configure the page footer (left / center / right text, or custom HTML).

pub fn display_header_footer(self, yes: bool) -> Self

Show or hide header & footer. Default: false.

pub fn print_background(self, yes: bool) -> Self

Print background colours/images. Default: true.

pub fn markdown_options(self, opts: MarkdownOptions) -> Self

Configure Markdown parsing extensions.

pub fn chrome_window_size(self, width: u32, height: u32) -> Self

Chrome window size. Default: (1280, 900).

pub fn page_load_wait_secs(self, secs: u64) -> Self

Seconds to wait after page load. Default: 2.

pub fn heading_numbers(self, yes: bool) -> Self

Enable automatic hierarchical heading numbers (1, 1.1, 1.1.1, …) via CSS counters. Works with all input types.

pub fn from_markdown(self, md: &str) -> Result<Vec<u8>>

Generate a PDF from a Markdown string.

pub fn from_json(self, json_doc: &Value) -> Result<Vec<u8>>

Generate a PDF from structured JSON content blocks.

The JSON is converted to Markdown first, then rendered with the same pipeline as from_markdown.

JSON Structure

An array of content blocks (or an object with a "content" array):

[
  { "type": "heading", "level": 1, "text": "Title" },
  { "type": "paragraph", "text": "Some **bold** text." },
  { "type": "code", "language": "rust", "text": "fn main() {}" },
  { "type": "list", "ordered": false, "items": ["A", "B", "C"] },
  { "type": "quote", "text": "A wise quote." },
  { "type": "table", "headers": ["X","Y"], "rows": [["1","2"]] },
  { "type": "image", "src": "https://…", "alt": "photo" },
  { "type": "divider" },
  { "type": "html", "text": "<b>raw HTML</b>" }
]

pub fn from_html(self, html: &str) -> Result<Vec<u8>>

Generate a PDF from a pre-built HTML string.

The HTML is used as-is — no Markdown conversion, no CSS injection. Header/footer and Chrome options still apply.

pub fn from_markdown_file(self, path: impl AsRef<Path>) -> Result<Vec<u8>>

Generate a PDF from a Markdown file on disk.

pub fn from_json_file(self, path: impl AsRef<Path>) -> Result<Vec<u8>>

Generate a PDF from a JSON file on disk.

Trait Implementations

impl Default for PdfBuilder

fn default() -> Self

Returns the “default value” for a type.