Struct PDF

pub struct PDF { /* private fields */ }

A PDF file

This struct wraps the bytes of an PDF and additional information about the PDF, such as the number of pages and whether the PDF is encrypted.

Usage

use pdf2image::{PDF, Pages, RenderOptionsBuilder};

fn main() -> Result<(), pdf2img::Error> {
    let pdf = PDF::from_file("examples/pdfs/ropes.pdf")?;
    let rendered_pages = pdf.render(Pages::All, RenderOptionsBuilder::default().build()?)?;
}

Rationale

Storing the page count prevents calls to pdfinfo for every call to render().

Implementations

impl PDF

pub fn from_bytes(data: Vec<u8>) -> Result<Self>

Constructs a PDF from bytes.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Constructs a PDF from a PDF file.

Examples found in repository

examples/render_pages.rs (line 4)

fn main() -> Result<(), PDF2ImageError> {
    let pdf = PDF::from_file("examples/pdfs/ropes.pdf").unwrap();
    let pages = pdf.render(
        pdf2image::Pages::Range(1..=8),
        RenderOptionsBuilder::default().pdftocairo(true).build()?,
    );
    println!("{:?}", pages.unwrap().len());

    Ok(())
}

pub fn page_count(&self) -> u32

Returns the number of pages in the PDF.

pub fn is_encrypted(&self) -> bool

Returns whether the PDF is encrypted.

pub fn render( &self, pages: Pages, options: impl Into<Option<RenderOptions>>, ) -> Result<Vec<DynamicImage>>

Renders the PDF to images.

Examples found in repository

examples/render_pages.rs (lines 5-8)

fn main() -> Result<(), PDF2ImageError> {
    let pdf = PDF::from_file("examples/pdfs/ropes.pdf").unwrap();
    let pages = pdf.render(
        pdf2image::Pages::Range(1..=8),
        RenderOptionsBuilder::default().pdftocairo(true).build()?,
    );
    println!("{:?}", pages.unwrap().len());

    Ok(())
}