Struct DocumentBuilder 

pub struct DocumentBuilder { /* private fields */ }

High-level builder for creating complete PDF documents.

Implementations

impl DocumentBuilder

pub fn new() -> DocumentBuilder

Create a new document builder.

Examples found in repository

examples/create_pdf.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<String> = std::env::args().collect();
    let output = args.get(1).map(|s| s.as_str()).unwrap_or("created.pdf");

    let mut builder = DocumentBuilder::new();
    builder.set_title("Created by justpdf");
    builder.set_author("justpdf example");

    let font = builder.add_standard_font("Helvetica");

    // Page 1
    let mut page1 = PageBuilder::new(612.0, 792.0);
    page1.add_font(&font, "Helvetica");
    page1.begin_text();
    page1.set_font(&font, 36.0);
    page1.move_to(72.0, 700.0);
    page1.show_text("Hello, justpdf!");
    page1.end_text();

    page1.begin_text();
    page1.set_font(&font, 14.0);
    page1.move_to(72.0, 650.0);
    page1.show_text("This PDF was created with the justpdf Rust library.");
    page1.end_text();

    // Draw a rectangle
    page1.set_fill_rgb(0.2, 0.4, 0.8);
    page1.fill_rect(72.0, 500.0, 468.0, 2.0);

    builder.add_page(page1);

    // Page 2
    let mut page2 = PageBuilder::new(612.0, 792.0);
    page2.add_font(&font, "Helvetica");
    page2.begin_text();
    page2.set_font(&font, 24.0);
    page2.move_to(72.0, 700.0);
    page2.show_text("Page 2");
    page2.end_text();
    builder.add_page(page2);

    let bytes = builder.build()?;
    std::fs::write(output, &bytes)?;
    println!("Created {output} ({} bytes, 2 pages)", bytes.len());

    Ok(())
}

pub fn add_standard_font(&mut self, base_font: &str) -> String

Add a standard Type1 font (e.g. “Helvetica”, “Times-Roman”, “Courier”).

Returns the resource name (e.g. “F1”) to use when drawing text.

Examples found in repository

examples/create_pdf.rs (line 15)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<String> = std::env::args().collect();
    let output = args.get(1).map(|s| s.as_str()).unwrap_or("created.pdf");

    let mut builder = DocumentBuilder::new();
    builder.set_title("Created by justpdf");
    builder.set_author("justpdf example");

    let font = builder.add_standard_font("Helvetica");

    // Page 1
    let mut page1 = PageBuilder::new(612.0, 792.0);
    page1.add_font(&font, "Helvetica");
    page1.begin_text();
    page1.set_font(&font, 36.0);
    page1.move_to(72.0, 700.0);
    page1.show_text("Hello, justpdf!");
    page1.end_text();

    page1.begin_text();
    page1.set_font(&font, 14.0);
    page1.move_to(72.0, 650.0);
    page1.show_text("This PDF was created with the justpdf Rust library.");
    page1.end_text();

    // Draw a rectangle
    page1.set_fill_rgb(0.2, 0.4, 0.8);
    page1.fill_rect(72.0, 500.0, 468.0, 2.0);

    builder.add_page(page1);

    // Page 2
    let mut page2 = PageBuilder::new(612.0, 792.0);
    page2.add_font(&font, "Helvetica");
    page2.begin_text();
    page2.set_font(&font, 24.0);
    page2.move_to(72.0, 700.0);
    page2.show_text("Page 2");
    page2.end_text();
    builder.add_page(page2);

    let bytes = builder.build()?;
    std::fs::write(output, &bytes)?;
    println!("Created {output} ({} bytes, 2 pages)", bytes.len());

    Ok(())
}

pub fn add_page(&mut self, page: PageBuilder)

Add a page to the document from a PageBuilder.

Examples found in repository

examples/create_pdf.rs (line 36)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<String> = std::env::args().collect();
    let output = args.get(1).map(|s| s.as_str()).unwrap_or("created.pdf");

    let mut builder = DocumentBuilder::new();
    builder.set_title("Created by justpdf");
    builder.set_author("justpdf example");

    let font = builder.add_standard_font("Helvetica");

    // Page 1
    let mut page1 = PageBuilder::new(612.0, 792.0);
    page1.add_font(&font, "Helvetica");
    page1.begin_text();
    page1.set_font(&font, 36.0);
    page1.move_to(72.0, 700.0);
    page1.show_text("Hello, justpdf!");
    page1.end_text();

    page1.begin_text();
    page1.set_font(&font, 14.0);
    page1.move_to(72.0, 650.0);
    page1.show_text("This PDF was created with the justpdf Rust library.");
    page1.end_text();

    // Draw a rectangle
    page1.set_fill_rgb(0.2, 0.4, 0.8);
    page1.fill_rect(72.0, 500.0, 468.0, 2.0);

    builder.add_page(page1);

    // Page 2
    let mut page2 = PageBuilder::new(612.0, 792.0);
    page2.add_font(&font, "Helvetica");
    page2.begin_text();
    page2.set_font(&font, 24.0);
    page2.move_to(72.0, 700.0);
    page2.show_text("Page 2");
    page2.end_text();
    builder.add_page(page2);

    let bytes = builder.build()?;
    std::fs::write(output, &bytes)?;
    println!("Created {output} ({} bytes, 2 pages)", bytes.len());

    Ok(())
}

pub fn set_title(&mut self, title: &str)

Set the document title.

Examples found in repository

examples/create_pdf.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<String> = std::env::args().collect();
    let output = args.get(1).map(|s| s.as_str()).unwrap_or("created.pdf");

    let mut builder = DocumentBuilder::new();
    builder.set_title("Created by justpdf");
    builder.set_author("justpdf example");

    let font = builder.add_standard_font("Helvetica");

    // Page 1
    let mut page1 = PageBuilder::new(612.0, 792.0);
    page1.add_font(&font, "Helvetica");
    page1.begin_text();
    page1.set_font(&font, 36.0);
    page1.move_to(72.0, 700.0);
    page1.show_text("Hello, justpdf!");
    page1.end_text();

    page1.begin_text();
    page1.set_font(&font, 14.0);
    page1.move_to(72.0, 650.0);
    page1.show_text("This PDF was created with the justpdf Rust library.");
    page1.end_text();

    // Draw a rectangle
    page1.set_fill_rgb(0.2, 0.4, 0.8);
    page1.fill_rect(72.0, 500.0, 468.0, 2.0);

    builder.add_page(page1);

    // Page 2
    let mut page2 = PageBuilder::new(612.0, 792.0);
    page2.add_font(&font, "Helvetica");
    page2.begin_text();
    page2.set_font(&font, 24.0);
    page2.move_to(72.0, 700.0);
    page2.show_text("Page 2");
    page2.end_text();
    builder.add_page(page2);

    let bytes = builder.build()?;
    std::fs::write(output, &bytes)?;
    println!("Created {output} ({} bytes, 2 pages)", bytes.len());

    Ok(())
}

pub fn set_author(&mut self, author: &str)

Set the document author.

Examples found in repository

examples/create_pdf.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<String> = std::env::args().collect();
    let output = args.get(1).map(|s| s.as_str()).unwrap_or("created.pdf");

    let mut builder = DocumentBuilder::new();
    builder.set_title("Created by justpdf");
    builder.set_author("justpdf example");

    let font = builder.add_standard_font("Helvetica");

    // Page 1
    let mut page1 = PageBuilder::new(612.0, 792.0);
    page1.add_font(&font, "Helvetica");
    page1.begin_text();
    page1.set_font(&font, 36.0);
    page1.move_to(72.0, 700.0);
    page1.show_text("Hello, justpdf!");
    page1.end_text();

    page1.begin_text();
    page1.set_font(&font, 14.0);
    page1.move_to(72.0, 650.0);
    page1.show_text("This PDF was created with the justpdf Rust library.");
    page1.end_text();

    // Draw a rectangle
    page1.set_fill_rgb(0.2, 0.4, 0.8);
    page1.fill_rect(72.0, 500.0, 468.0, 2.0);

    builder.add_page(page1);

    // Page 2
    let mut page2 = PageBuilder::new(612.0, 792.0);
    page2.add_font(&font, "Helvetica");
    page2.begin_text();
    page2.set_font(&font, 24.0);
    page2.move_to(72.0, 700.0);
    page2.show_text("Page 2");
    page2.end_text();
    builder.add_page(page2);

    let bytes = builder.build()?;
    std::fs::write(output, &bytes)?;
    println!("Created {output} ({} bytes, 2 pages)", bytes.len());

    Ok(())
}

pub fn set_subject(&mut self, subject: &str)

Set the document subject.

pub fn set_producer(&mut self, producer: &str)

Set the producer field.

pub fn set_creator(&mut self, creator: &str)

Set the creator field.

pub fn embed_truetype_font( &mut self, font_data: &[u8], ) -> Result<String, JustPdfError>

Embed a TrueType font from raw TTF data.

Returns the resource name (e.g. “F1”, “F2”) for use in page content. The font is embedded with WinAnsiEncoding and a ToUnicode CMap.

pub fn set_encryption(&mut self, config: EncryptionConfig)

Set encryption for the document.

pub fn set_xmp_metadata( &mut self, title: &str, author: &str, subject: &str, creator: &str, )

Set XMP metadata on the document catalog.

Generates an XMP XML metadata stream with the given fields and attaches it to the Catalog as /Metadata.

pub fn build(self) -> Result<Vec<u8>, JustPdfError>

Build the document and return the PDF bytes.

Examples found in repository

examples/create_pdf.rs (line 48)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<String> = std::env::args().collect();
    let output = args.get(1).map(|s| s.as_str()).unwrap_or("created.pdf");

    let mut builder = DocumentBuilder::new();
    builder.set_title("Created by justpdf");
    builder.set_author("justpdf example");

    let font = builder.add_standard_font("Helvetica");

    // Page 1
    let mut page1 = PageBuilder::new(612.0, 792.0);
    page1.add_font(&font, "Helvetica");
    page1.begin_text();
    page1.set_font(&font, 36.0);
    page1.move_to(72.0, 700.0);
    page1.show_text("Hello, justpdf!");
    page1.end_text();

    page1.begin_text();
    page1.set_font(&font, 14.0);
    page1.move_to(72.0, 650.0);
    page1.show_text("This PDF was created with the justpdf Rust library.");
    page1.end_text();

    // Draw a rectangle
    page1.set_fill_rgb(0.2, 0.4, 0.8);
    page1.fill_rect(72.0, 500.0, 468.0, 2.0);

    builder.add_page(page1);

    // Page 2
    let mut page2 = PageBuilder::new(612.0, 792.0);
    page2.add_font(&font, "Helvetica");
    page2.begin_text();
    page2.set_font(&font, 24.0);
    page2.move_to(72.0, 700.0);
    page2.show_text("Page 2");
    page2.end_text();
    builder.add_page(page2);

    let bytes = builder.build()?;
    std::fs::write(output, &bytes)?;
    println!("Created {output} ({} bytes, 2 pages)", bytes.len());

    Ok(())
}

pub fn save(self, path: &Path) -> Result<(), JustPdfError>

Build the document and save to a file.

Trait Implementations

impl Default for DocumentBuilder

fn default() -> DocumentBuilder

Returns the “default value” for a type.