Struct Pdf

pub struct Pdf { /* private fields */ }

The top-level object for writing a PDF.

A PDF file is created with the create or new methods. Some metadata can be stored with set_foo methods, and pages are appended with the render_page method. Don’t forget to call finish when done, to write the document trailer, without it the written file won’t be a proper PDF.

Implementations

impl Pdf

pub fn create(filename: &str) -> Result<Pdf>

Create a new PDF document as a new file with given filename.

Examples found in repository

examples/circles.rs (line 16)

fn main() {
    // Open our pdf document.
    let mut document = Pdf::create("circles.pdf").unwrap();

    // Add a 400x400 pt page.

    // Render-page writes the pdf file structure for a page and
    // creates a Canvas which is sent to the function that is the last
    // argument of the render_page method.
    // That function then puts content on the page by calling methods
    // on the canvas.
    document
        .render_page(400.0, 400.0, |c| {
            let (x, y) = (200.0, 200.0);
            let r = 190.0;

            // Set a wide black pen and stroke a circle
            c.set_stroke_color(Color::rgb(0, 0, 0))?;
            c.set_line_width(2.0)?;
            c.circle(x, y, r)?;
            c.stroke()?;

            // Set a finer yellow pen and stroke a 200-sided polygon
            c.set_stroke_color(Color::rgb(255, 230, 150))?;
            c.set_line_width(1.0)?;
            c.move_to(x + r, y)?;
            let sides: u8 = 200;
            for n in 1..sides {
                let phi = f32::from(n) * 2.0 * PI / f32::from(sides);
                c.line_to(x + r * phi.cos(), y + r * phi.sin())?;
            }
            c.close_and_stroke()
        })
        .unwrap();
    document.finish().unwrap();
}

examples/mandala.rs (line 12)

fn main() {
    // Open our pdf document.
    let mut document = Pdf::create("mandala.pdf").expect("Create PDF file");
    let mut args = env::args().skip(1);
    let n: u8 = args.next().map(|s| s.parse().expect("number")).unwrap_or(7);

    // Render a page with something resembling a mandala on it.
    document
        .render_page(600.0, 600.0, |c| {
            c.concat(Matrix::translate(300., 300.))?;
            c.set_stroke_color(Color::gray(0))?;
            let segment = 2. * PI / n as f32;
            for _i in 0..n {
                c.move_to(0., 33.5)?;
                c.line_to(0., 250.)?;
                let r = 99.;
                c.circle(0., r, r * 1.25 * segment)?;
                let d = 141.4;
                let rr = 36.;
                c.circle(0., d + rr, rr)?;
                c.stroke()?;
                c.concat(Matrix::rotate(segment))?;
            }
            c.concat(Matrix::rotate(segment / 2.))?;
            for _i in 0..n {
                let mut r0 = 58.66;
                let mut r = 0.7705 * r0 * segment;
                for _j in 0..(n + 1) / 3 {
                    c.circle(0., r0, r)?;
                    let r2 = 1.058 * r;
                    r0 = r0 + r + r2;
                    r = r2;
                }
                c.stroke()?;
                c.concat(Matrix::rotate(segment))?;
            }

            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}

examples/text.rs (line 10)

fn main() {
    let mut document = Pdf::create("text.pdf").unwrap();
    document.set_title("Text example");
    document
        .render_page(300.0, 400.0, |c| {
            c.set_stroke_color(Color::rgb(200, 200, 255))?;
            c.rectangle(10.0, 10.0, 280.0, 380.0)?;
            c.line(10.0, 300.0, 290.0, 300.0)?;
            c.line(150.0, 10.0, 150.0, 390.0)?;
            c.stroke()?;
            let helvetica = BuiltinFont::Helvetica;
            c.left_text(10.0, 380.0, helvetica, 12.0, "Top left")?;
            c.left_text(10.0, 10.0, helvetica, 12.0, "Bottom left")?;
            c.right_text(290.0, 380.0, helvetica, 12.0, "Top right")?;
            c.right_text(290.0, 10.0, helvetica, 12.0, "Bottom right")?;
            c.center_text(
                150.0,
                330.0,
                BuiltinFont::Times_Bold,
                18.0,
                "Centered",
            )?;
            let times = c.get_font(BuiltinFont::Times_Roman);
            c.text(|t| {
                t.set_font(&times, 14.0)?;
                t.set_leading(18.0)?;
                t.pos(10.0, 300.0)?;
                t.show("Some lines of text in what might look like a")?;
                t.show_line("paragraph of three lines. Lorem ipsum dolor")?;
                t.show_line("sit amet. Blahonga. ")?;
                t.show_adjusted(&[("W", 130), ("AN", -40), ("D", 0)])?;
                t.pos(0., -30.)?;
                t.show_adjusted(
                    &(-19..21).map(|i| ("o", 16 * i)).collect::<Vec<_>>(),
                )
            })?;

            // In Swedish, we use the letters å, ä, and ö
            // in words like sloe liqueur.  That is why rust-pdf
            // uses /WinAnsiEncoding for text.
            let times_italic = BuiltinFont::Times_Italic;
            c.right_text(
                290.0,
                200.0,
                times_italic,
                14.0,
                "På svenska använder vi bokstäverna å, ä & ö",
            )?;
            c.right_text(
                290.0,
                182.0,
                times_italic,
                14.0,
                "i ord som slånbärslikör. Därför använder",
            )?;
            c.right_text(
                290.0,
                164.0,
                times_italic,
                14.0,
                "rust-pdf /WinAnsiEncoding för text.",
            )?;

            c.center_text(
                150.0,
                130.0,
                BuiltinFont::Symbol,
                14.0,
                "Hellas ΑΒΓΔαβγδ",
            )?;
            c.center_text(
                150.0,
                114.0,
                BuiltinFont::Symbol,
                14.0,
                "∀ μ < δ : ∃ σ ∈ Σ",
            )?;
            c.center_text(
                150.0,
                90.0,
                BuiltinFont::ZapfDingbats,
                14.0,
                "♥♠♦♣",
            )?;
            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}

pub fn new(output: File) -> Result<Pdf>

Create a new PDF document, writing to output.

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

Set metadata: the document’s title.

Examples found in repository

examples/text.rs (line 11)

fn main() {
    let mut document = Pdf::create("text.pdf").unwrap();
    document.set_title("Text example");
    document
        .render_page(300.0, 400.0, |c| {
            c.set_stroke_color(Color::rgb(200, 200, 255))?;
            c.rectangle(10.0, 10.0, 280.0, 380.0)?;
            c.line(10.0, 300.0, 290.0, 300.0)?;
            c.line(150.0, 10.0, 150.0, 390.0)?;
            c.stroke()?;
            let helvetica = BuiltinFont::Helvetica;
            c.left_text(10.0, 380.0, helvetica, 12.0, "Top left")?;
            c.left_text(10.0, 10.0, helvetica, 12.0, "Bottom left")?;
            c.right_text(290.0, 380.0, helvetica, 12.0, "Top right")?;
            c.right_text(290.0, 10.0, helvetica, 12.0, "Bottom right")?;
            c.center_text(
                150.0,
                330.0,
                BuiltinFont::Times_Bold,
                18.0,
                "Centered",
            )?;
            let times = c.get_font(BuiltinFont::Times_Roman);
            c.text(|t| {
                t.set_font(&times, 14.0)?;
                t.set_leading(18.0)?;
                t.pos(10.0, 300.0)?;
                t.show("Some lines of text in what might look like a")?;
                t.show_line("paragraph of three lines. Lorem ipsum dolor")?;
                t.show_line("sit amet. Blahonga. ")?;
                t.show_adjusted(&[("W", 130), ("AN", -40), ("D", 0)])?;
                t.pos(0., -30.)?;
                t.show_adjusted(
                    &(-19..21).map(|i| ("o", 16 * i)).collect::<Vec<_>>(),
                )
            })?;

            // In Swedish, we use the letters å, ä, and ö
            // in words like sloe liqueur.  That is why rust-pdf
            // uses /WinAnsiEncoding for text.
            let times_italic = BuiltinFont::Times_Italic;
            c.right_text(
                290.0,
                200.0,
                times_italic,
                14.0,
                "På svenska använder vi bokstäverna å, ä & ö",
            )?;
            c.right_text(
                290.0,
                182.0,
                times_italic,
                14.0,
                "i ord som slånbärslikör. Därför använder",
            )?;
            c.right_text(
                290.0,
                164.0,
                times_italic,
                14.0,
                "rust-pdf /WinAnsiEncoding för text.",
            )?;

            c.center_text(
                150.0,
                130.0,
                BuiltinFont::Symbol,
                14.0,
                "Hellas ΑΒΓΔαβγδ",
            )?;
            c.center_text(
                150.0,
                114.0,
                BuiltinFont::Symbol,
                14.0,
                "∀ μ < δ : ∃ σ ∈ Σ",
            )?;
            c.center_text(
                150.0,
                90.0,
                BuiltinFont::ZapfDingbats,
                14.0,
                "♥♠♦♣",
            )?;
            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}

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

Set metadata: the name of the person who created the document.

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

Set metadata: the subject of the document.

pub fn set_keywords(&mut self, keywords: &str)

Set metadata: keywords associated with the document.

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

Set metadata: If the document was converted to PDF from another format, the name of the conforming product that created the original document from which it was converted.

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

Set metadata: If the document was converted to PDF from another format, the name of the conforming product that converted it to PDF.

pub fn render_page<F>( &mut self, width: f32, height: f32, render_contents: F, ) -> Result<()>

where F: FnOnce(&mut Canvas<'_>) -> Result<()>,

Create a new page in the PDF document.

The page will be width x height points large, and the actual content of the page will be created by the function render_contents by applying drawing methods on the Canvas.

Examples found in repository

examples/circles.rs (lines 26-46)

fn main() {
    // Open our pdf document.
    let mut document = Pdf::create("circles.pdf").unwrap();

    // Add a 400x400 pt page.

    // Render-page writes the pdf file structure for a page and
    // creates a Canvas which is sent to the function that is the last
    // argument of the render_page method.
    // That function then puts content on the page by calling methods
    // on the canvas.
    document
        .render_page(400.0, 400.0, |c| {
            let (x, y) = (200.0, 200.0);
            let r = 190.0;

            // Set a wide black pen and stroke a circle
            c.set_stroke_color(Color::rgb(0, 0, 0))?;
            c.set_line_width(2.0)?;
            c.circle(x, y, r)?;
            c.stroke()?;

            // Set a finer yellow pen and stroke a 200-sided polygon
            c.set_stroke_color(Color::rgb(255, 230, 150))?;
            c.set_line_width(1.0)?;
            c.move_to(x + r, y)?;
            let sides: u8 = 200;
            for n in 1..sides {
                let phi = f32::from(n) * 2.0 * PI / f32::from(sides);
                c.line_to(x + r * phi.cos(), y + r * phi.sin())?;
            }
            c.close_and_stroke()
        })
        .unwrap();
    document.finish().unwrap();
}

examples/mandala.rs (lines 18-48)

fn main() {
    // Open our pdf document.
    let mut document = Pdf::create("mandala.pdf").expect("Create PDF file");
    let mut args = env::args().skip(1);
    let n: u8 = args.next().map(|s| s.parse().expect("number")).unwrap_or(7);

    // Render a page with something resembling a mandala on it.
    document
        .render_page(600.0, 600.0, |c| {
            c.concat(Matrix::translate(300., 300.))?;
            c.set_stroke_color(Color::gray(0))?;
            let segment = 2. * PI / n as f32;
            for _i in 0..n {
                c.move_to(0., 33.5)?;
                c.line_to(0., 250.)?;
                let r = 99.;
                c.circle(0., r, r * 1.25 * segment)?;
                let d = 141.4;
                let rr = 36.;
                c.circle(0., d + rr, rr)?;
                c.stroke()?;
                c.concat(Matrix::rotate(segment))?;
            }
            c.concat(Matrix::rotate(segment / 2.))?;
            for _i in 0..n {
                let mut r0 = 58.66;
                let mut r = 0.7705 * r0 * segment;
                for _j in 0..(n + 1) / 3 {
                    c.circle(0., r0, r)?;
                    let r2 = 1.058 * r;
                    r0 = r0 + r + r2;
                    r = r2;
                }
                c.stroke()?;
                c.concat(Matrix::rotate(segment))?;
            }

            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}

examples/text.rs (lines 13-94)

fn main() {
    let mut document = Pdf::create("text.pdf").unwrap();
    document.set_title("Text example");
    document
        .render_page(300.0, 400.0, |c| {
            c.set_stroke_color(Color::rgb(200, 200, 255))?;
            c.rectangle(10.0, 10.0, 280.0, 380.0)?;
            c.line(10.0, 300.0, 290.0, 300.0)?;
            c.line(150.0, 10.0, 150.0, 390.0)?;
            c.stroke()?;
            let helvetica = BuiltinFont::Helvetica;
            c.left_text(10.0, 380.0, helvetica, 12.0, "Top left")?;
            c.left_text(10.0, 10.0, helvetica, 12.0, "Bottom left")?;
            c.right_text(290.0, 380.0, helvetica, 12.0, "Top right")?;
            c.right_text(290.0, 10.0, helvetica, 12.0, "Bottom right")?;
            c.center_text(
                150.0,
                330.0,
                BuiltinFont::Times_Bold,
                18.0,
                "Centered",
            )?;
            let times = c.get_font(BuiltinFont::Times_Roman);
            c.text(|t| {
                t.set_font(&times, 14.0)?;
                t.set_leading(18.0)?;
                t.pos(10.0, 300.0)?;
                t.show("Some lines of text in what might look like a")?;
                t.show_line("paragraph of three lines. Lorem ipsum dolor")?;
                t.show_line("sit amet. Blahonga. ")?;
                t.show_adjusted(&[("W", 130), ("AN", -40), ("D", 0)])?;
                t.pos(0., -30.)?;
                t.show_adjusted(
                    &(-19..21).map(|i| ("o", 16 * i)).collect::<Vec<_>>(),
                )
            })?;

            // In Swedish, we use the letters å, ä, and ö
            // in words like sloe liqueur.  That is why rust-pdf
            // uses /WinAnsiEncoding for text.
            let times_italic = BuiltinFont::Times_Italic;
            c.right_text(
                290.0,
                200.0,
                times_italic,
                14.0,
                "På svenska använder vi bokstäverna å, ä & ö",
            )?;
            c.right_text(
                290.0,
                182.0,
                times_italic,
                14.0,
                "i ord som slånbärslikör. Därför använder",
            )?;
            c.right_text(
                290.0,
                164.0,
                times_italic,
                14.0,
                "rust-pdf /WinAnsiEncoding för text.",
            )?;

            c.center_text(
                150.0,
                130.0,
                BuiltinFont::Symbol,
                14.0,
                "Hellas ΑΒΓΔαβγδ",
            )?;
            c.center_text(
                150.0,
                114.0,
                BuiltinFont::Symbol,
                14.0,
                "∀ μ < δ : ∃ σ ∈ Σ",
            )?;
            c.center_text(
                150.0,
                90.0,
                BuiltinFont::ZapfDingbats,
                14.0,
                "♥♠♦♣",
            )?;
            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}

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

Write out the document trailer. The trailer consists of the pages object, the root object, the xref list, the trailer object and the startxref position.

Examples found in repository

examples/circles.rs (line 48)

fn main() {
    // Open our pdf document.
    let mut document = Pdf::create("circles.pdf").unwrap();

    // Add a 400x400 pt page.

    // Render-page writes the pdf file structure for a page and
    // creates a Canvas which is sent to the function that is the last
    // argument of the render_page method.
    // That function then puts content on the page by calling methods
    // on the canvas.
    document
        .render_page(400.0, 400.0, |c| {
            let (x, y) = (200.0, 200.0);
            let r = 190.0;

            // Set a wide black pen and stroke a circle
            c.set_stroke_color(Color::rgb(0, 0, 0))?;
            c.set_line_width(2.0)?;
            c.circle(x, y, r)?;
            c.stroke()?;

            // Set a finer yellow pen and stroke a 200-sided polygon
            c.set_stroke_color(Color::rgb(255, 230, 150))?;
            c.set_line_width(1.0)?;
            c.move_to(x + r, y)?;
            let sides: u8 = 200;
            for n in 1..sides {
                let phi = f32::from(n) * 2.0 * PI / f32::from(sides);
                c.line_to(x + r * phi.cos(), y + r * phi.sin())?;
            }
            c.close_and_stroke()
        })
        .unwrap();
    document.finish().unwrap();
}

examples/mandala.rs (line 50)

fn main() {
    // Open our pdf document.
    let mut document = Pdf::create("mandala.pdf").expect("Create PDF file");
    let mut args = env::args().skip(1);
    let n: u8 = args.next().map(|s| s.parse().expect("number")).unwrap_or(7);

    // Render a page with something resembling a mandala on it.
    document
        .render_page(600.0, 600.0, |c| {
            c.concat(Matrix::translate(300., 300.))?;
            c.set_stroke_color(Color::gray(0))?;
            let segment = 2. * PI / n as f32;
            for _i in 0..n {
                c.move_to(0., 33.5)?;
                c.line_to(0., 250.)?;
                let r = 99.;
                c.circle(0., r, r * 1.25 * segment)?;
                let d = 141.4;
                let rr = 36.;
                c.circle(0., d + rr, rr)?;
                c.stroke()?;
                c.concat(Matrix::rotate(segment))?;
            }
            c.concat(Matrix::rotate(segment / 2.))?;
            for _i in 0..n {
                let mut r0 = 58.66;
                let mut r = 0.7705 * r0 * segment;
                for _j in 0..(n + 1) / 3 {
                    c.circle(0., r0, r)?;
                    let r2 = 1.058 * r;
                    r0 = r0 + r + r2;
                    r = r2;
                }
                c.stroke()?;
                c.concat(Matrix::rotate(segment))?;
            }

            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}

examples/text.rs (line 96)

fn main() {
    let mut document = Pdf::create("text.pdf").unwrap();
    document.set_title("Text example");
    document
        .render_page(300.0, 400.0, |c| {
            c.set_stroke_color(Color::rgb(200, 200, 255))?;
            c.rectangle(10.0, 10.0, 280.0, 380.0)?;
            c.line(10.0, 300.0, 290.0, 300.0)?;
            c.line(150.0, 10.0, 150.0, 390.0)?;
            c.stroke()?;
            let helvetica = BuiltinFont::Helvetica;
            c.left_text(10.0, 380.0, helvetica, 12.0, "Top left")?;
            c.left_text(10.0, 10.0, helvetica, 12.0, "Bottom left")?;
            c.right_text(290.0, 380.0, helvetica, 12.0, "Top right")?;
            c.right_text(290.0, 10.0, helvetica, 12.0, "Bottom right")?;
            c.center_text(
                150.0,
                330.0,
                BuiltinFont::Times_Bold,
                18.0,
                "Centered",
            )?;
            let times = c.get_font(BuiltinFont::Times_Roman);
            c.text(|t| {
                t.set_font(&times, 14.0)?;
                t.set_leading(18.0)?;
                t.pos(10.0, 300.0)?;
                t.show("Some lines of text in what might look like a")?;
                t.show_line("paragraph of three lines. Lorem ipsum dolor")?;
                t.show_line("sit amet. Blahonga. ")?;
                t.show_adjusted(&[("W", 130), ("AN", -40), ("D", 0)])?;
                t.pos(0., -30.)?;
                t.show_adjusted(
                    &(-19..21).map(|i| ("o", 16 * i)).collect::<Vec<_>>(),
                )
            })?;

            // In Swedish, we use the letters å, ä, and ö
            // in words like sloe liqueur.  That is why rust-pdf
            // uses /WinAnsiEncoding for text.
            let times_italic = BuiltinFont::Times_Italic;
            c.right_text(
                290.0,
                200.0,
                times_italic,
                14.0,
                "På svenska använder vi bokstäverna å, ä & ö",
            )?;
            c.right_text(
                290.0,
                182.0,
                times_italic,
                14.0,
                "i ord som slånbärslikör. Därför använder",
            )?;
            c.right_text(
                290.0,
                164.0,
                times_italic,
                14.0,
                "rust-pdf /WinAnsiEncoding för text.",
            )?;

            c.center_text(
                150.0,
                130.0,
                BuiltinFont::Symbol,
                14.0,
                "Hellas ΑΒΓΔαβγδ",
            )?;
            c.center_text(
                150.0,
                114.0,
                BuiltinFont::Symbol,
                14.0,
                "∀ μ < δ : ∃ σ ∈ Σ",
            )?;
            c.center_text(
                150.0,
                90.0,
                BuiltinFont::ZapfDingbats,
                14.0,
                "♥♠♦♣",
            )?;
            Ok(())
        })
        .unwrap();
    document.finish().unwrap();
}