Struct PdfiumPage 

pub struct PdfiumPage { /* private fields */ }

Rust interface to FPDF_PAGE

Implementations

impl PdfiumPage

pub fn render(&self, config: &PdfiumRenderConfig) -> PdfiumResult<PdfiumBitmap>

Renders this PdfiumPage into a new PdfiumBitmap using the specified configuration.

This method handles the complex logic of translating the configuration parameters into the appropriate PDFium rendering calls, including dimension calculations, transformation matrix setup, and bitmap creation.

Arguments

• config - The rendering configuration to use

Returns

• Ok(PdfiumBitmap) - The rendered bitmap on success
• Err(PdfiumError) - An error describing what went wrong

Errors

This method can return errors for:

• Invalid configuration parameters
• PDFium rendering failures
• Memory allocation failures
• Page boundary calculation errors

Examples found in repository

examples/rotations.rs (line 51)

pub fn example_rotations() -> PdfiumResult<()> {
    // Load the PDF document from the specified file path
    // Parameters:
    // - "resources/groningen.pdf": Path to the PDF file (relative to current working directory)
    // - None: No password required for this PDF (use Some("password") if needed)
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    let config = PdfiumRenderConfig::new().with_height(1080);

    // Method 1: Rotate page before rendering

    let page_1 = document.page(0)?;

    assert!(!page_1.is_landscape());
    assert!(page_1.is_portrait());

    page_1.set_rotation(PdfiumRotation::Cw90);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-90-1.jpg", image::ImageFormat::Jpeg)?;

    assert!(page_1.is_landscape());

    page_1.set_rotation(PdfiumRotation::Cw180);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-180-1.jpg", image::ImageFormat::Jpeg)?;

    page_1.set_rotation(PdfiumRotation::Cw270);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-270-1.jpg", image::ImageFormat::Jpeg)?;

    // Method 2 (better): Use `with_rotation` when creating the `PdfiumRenderConfig`

    let page_2 = document.page(1)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw90))?;
    bitmap.save("groningen-rotation-90-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw180))?;
    bitmap.save("groningen-rotation-180-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw270))?;
    bitmap.save("groningen-rotation-270-2.jpg", image::ImageFormat::Jpeg)?;

    // Return success - all operations were successful
    Ok(())
}

examples/render_pages.rs (line 52)

pub fn example_export_pages_to_images() -> PdfiumResult<()> {
    // Load the PDF document from the specified file path
    // Parameters:
    // - "resources/groningen.pdf": Path to the PDF file (relative to current working directory)
    // - None: No password required for this PDF (use Some("password") if needed)
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    // Iterate through all pages in the document
    // document.pages() returns an iterator over all pages
    // enumerate() adds an index counter starting from 0
    // This gives us both the page object and its 0-based index
    for (index, page) in document.pages().enumerate() {
        // Render the current page as a bitmap image
        // This is where the PDF content gets converted to a raster image
        //
        // In the configuration we only specify the height in pixels. The width will be calculated
        // automatically to maintain aspect ratio.
        let config = PdfiumRenderConfig::new().with_height(1080);
        let bitmap = page?.render(&config)?;

        // Verify that the bitmap was rendered at the requested height
        // This assertion ensures the rendering process worked as expected
        // If this fails, it indicates a bug in the rendering logic
        assert_eq!(bitmap.height(), 1080);

        // Generate a unique filename for this page
        // Format: "groningen-page-{page_number}.jpg"
        // - index + 1 converts from 0-based index to 1-based page numbers
        //   * Page 0 becomes "groningen-page-1.jpg"
        //   * Page 1 becomes "groningen-page-2.jpg", etc.
        // - The .jpg extension indicates JPEG format will be used
        let filename = format!("groningen-page-{}.jpg", index + 1);

        // Save the rendered bitmap to disk as a JPEG image
        // Parameters:
        // - &filename: Reference to the generated filename string
        // - image::ImageFormat::Jpeg: Specifies JPEG compression format
        //   * Alternative format: Png (lossless)
        //   * JPEG provides good compression but is lossy (some quality loss)
        //
        // The save operation handles:
        // - Converting from BGRA format to JPEG-compatible format
        // - Applying JPEG compression
        // - Writing the file to disk
        bitmap.save(&filename, image::ImageFormat::Jpeg)?;

        // Note: No explicit cleanup needed - Rust's ownership system automatically
        // deallocates the bitmap memory when it goes out of scope at the end of this iteration
    }

    // Return success - all pages have been successfully exported
    Ok(())
}

impl PdfiumPage

pub fn boundaries(&self) -> PdfiumPageBoundaries<'_>

Rust interface to the boundary boxes of a page

pub fn object_count(&self) -> i32

Get number of page objects inside this PdfiumPage.

pub fn object(&self, index: i32) -> PdfiumResult<PdfiumPageObject>

Returns the PdfiumPageObject indicated by index from this PdfiumPage.

pub fn objects(&self) -> PdfiumPageObjects<'_>

Return an Iterator for the ojects in this PdfiumPage.

pub fn text(&self) -> PdfiumResult<PdfiumTextPage>

Get text page information structure

Contains information about all characters in a page.

Examples found in repository

examples/text_extract_search.rs (line 36)

pub fn example_extract_text() -> PdfiumResult<()> {
    // Load the PDF document from the specified file path
    // The second parameter (None) indicates no password is required
    let document = PdfiumDocument::new_from_path("resources/chapter1.pdf", None)?;

    // Iterate through all pages in the document
    // enumerate() provides both the index and the page object
    for (index, page) in document.pages().enumerate() {
        // Extract the full text content from the current page
        // The ?. operators handle potential errors at each step:
        // - page? ensures the page loaded successfully
        // - .text()? extracts text objects from the page
        // - .full() gets the complete text content as a string
        let text = page?.text()?.full();

        // Print formatted output for each page
        println!("Page {}", index + 1); // Pages are 1-indexed for user display
        println!("------");
        println!("{text}");
        println!() // Empty line for separation between pages
    }

    // Expected output:
    //
    // Page 1
    // ------
    //
    // Page 2
    // ------
    // Ruskin
    // House.
    // 156. Charing
    // Cross Road.
    // London
    // George Allen.
    //
    // Page 3
    // ------
    //
    // Page 4
    // ------
    // I
    // Chapter I.
    // T is a truth universally acknowledged, that a single man in possession of a good
    // fortune must be in want of a wife.
    // However little known the feelings or views of such a man may be on his first
    // entering a neighbourhood, this truth is so well fixed in the minds of the surrounding
    // families, that he is considered as the rightful property of some one or other of their
    // daughters.
    // “My dear Mr. Bennet,” said his lady to him one day, “have you heard that
    // Netherfield Park is let at last?”
    // ...

    Ok(())
}

/// Demonstrates text search functionality within a PDF document
pub fn example_search() -> PdfiumResult<()> {
    // Load the PDF document to search within
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    // Get the first page (index 0) for searching
    let page = document.page(0)?;

    // Extract text objects from the page for searching
    let text = page.text()?;

    // Search for "amsterdam" with case-insensitive matching
    // PdfiumSearchFlags::empty() means no special search flags (case-insensitive by default)
    // The last parameter (0) is the starting position for the search
    let search = text.find("amsterdam", PdfiumSearchFlags::empty(), 0);
    println!("Found amsterdam {} times", search.count());

    // Search for "groningen" with case-insensitive matching
    let search = text.find("groningen", PdfiumSearchFlags::empty(), 0);
    println!(
        "Found groningen {} times (case insensitive)",
        search.count()
    );

    // Search for "Groningen" with case-sensitive matching
    // MATCH_CASE flag enforces exact case matching
    let search = text.find("Groningen", PdfiumSearchFlags::MATCH_CASE, 0);
    println!("Found Groningen {} times (case sensitive)", search.count());

    // Perform another case-insensitive search to iterate through results
    let search = text.find("groningen", PdfiumSearchFlags::empty(), 0);

    // Iterate through each search result to extract detailed information
    for result in search {
        // Extract the text fragment at the found position
        // result.index() gives the character position where the match starts
        // result.count() gives the length of the matched text
        let fragment = text.extract(result.index(), result.count());
        println!(
            "Found groningen (case insensitive) at {}, fragment = '{fragment}'",
            result.index()
        );
    }

    // Expected output:
    //
    // Found amsterdam 0 times
    // Found groningen 5 times (case insensitive)
    // Found Groningen 5 times (case sensitive)
    // Found groningen (case insensitive) at 14, fragment = 'Groningen'
    // Found groningen (case insensitive) at 232, fragment = 'Groningen'
    // Found groningen (case insensitive) at 475, fragment = 'Groningen'
    // Found groningen (case insensitive) at 920, fragment = 'Groningen'
    // Found groningen (case insensitive) at 1050, fragment = 'Groningen'

    Ok(())
}

pub fn rotation(&self) -> PdfiumRotation

Get the rotation of this PdfiumPage.

Returns a PdfiumRotation indicating the page rotation

pub fn set_rotation(&self, rotate: PdfiumRotation)

Set rotation for this PdfiumPage.

rotate - the rotation value as PdfiumRotation

Examples found in repository

examples/rotations.rs (line 50)

pub fn example_rotations() -> PdfiumResult<()> {
    // Load the PDF document from the specified file path
    // Parameters:
    // - "resources/groningen.pdf": Path to the PDF file (relative to current working directory)
    // - None: No password required for this PDF (use Some("password") if needed)
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    let config = PdfiumRenderConfig::new().with_height(1080);

    // Method 1: Rotate page before rendering

    let page_1 = document.page(0)?;

    assert!(!page_1.is_landscape());
    assert!(page_1.is_portrait());

    page_1.set_rotation(PdfiumRotation::Cw90);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-90-1.jpg", image::ImageFormat::Jpeg)?;

    assert!(page_1.is_landscape());

    page_1.set_rotation(PdfiumRotation::Cw180);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-180-1.jpg", image::ImageFormat::Jpeg)?;

    page_1.set_rotation(PdfiumRotation::Cw270);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-270-1.jpg", image::ImageFormat::Jpeg)?;

    // Method 2 (better): Use `with_rotation` when creating the `PdfiumRenderConfig`

    let page_2 = document.page(1)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw90))?;
    bitmap.save("groningen-rotation-90-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw180))?;
    bitmap.save("groningen-rotation-180-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw270))?;
    bitmap.save("groningen-rotation-270-2.jpg", image::ImageFormat::Jpeg)?;

    // Return success - all operations were successful
    Ok(())
}

pub fn height(&self) -> f32

Get page height.

Return value:

• Page height (excluding non-displayable area) measured in points. One point is 1/72 inch (around 0.3528 mm)

Comments:

• Changing the rotation of |page| affects the return value.

pub fn width(&self) -> f32

Get page width.

Return value:

• Page width (excluding non-displayable area) measured in points. One point is 1/72 inch (around 0.3528 mm).

Comments:

• Changing the rotation of |page| affects the return value.

pub fn is_landscape(&self) -> bool

Check for landscape orientation.

Return value:

• true if width is larger than height, otherwise false

Comments:

• Square is neither landscape nor portrait
• Changing the rotation of the page affects the return value.

Examples found in repository

examples/rotations.rs (line 47)

pub fn example_rotations() -> PdfiumResult<()> {
    // Load the PDF document from the specified file path
    // Parameters:
    // - "resources/groningen.pdf": Path to the PDF file (relative to current working directory)
    // - None: No password required for this PDF (use Some("password") if needed)
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    let config = PdfiumRenderConfig::new().with_height(1080);

    // Method 1: Rotate page before rendering

    let page_1 = document.page(0)?;

    assert!(!page_1.is_landscape());
    assert!(page_1.is_portrait());

    page_1.set_rotation(PdfiumRotation::Cw90);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-90-1.jpg", image::ImageFormat::Jpeg)?;

    assert!(page_1.is_landscape());

    page_1.set_rotation(PdfiumRotation::Cw180);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-180-1.jpg", image::ImageFormat::Jpeg)?;

    page_1.set_rotation(PdfiumRotation::Cw270);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-270-1.jpg", image::ImageFormat::Jpeg)?;

    // Method 2 (better): Use `with_rotation` when creating the `PdfiumRenderConfig`

    let page_2 = document.page(1)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw90))?;
    bitmap.save("groningen-rotation-90-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw180))?;
    bitmap.save("groningen-rotation-180-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw270))?;
    bitmap.save("groningen-rotation-270-2.jpg", image::ImageFormat::Jpeg)?;

    // Return success - all operations were successful
    Ok(())
}

pub fn is_portrait(&self) -> bool

Check for portrait orientation.

Return value:

• true if width is smaller than height, otherwise false

Comments:

• Square is neither landscape nor portrait
• Changing the rotation of the page affects the return value.

Examples found in repository

examples/rotations.rs (line 48)

pub fn example_rotations() -> PdfiumResult<()> {
    // Load the PDF document from the specified file path
    // Parameters:
    // - "resources/groningen.pdf": Path to the PDF file (relative to current working directory)
    // - None: No password required for this PDF (use Some("password") if needed)
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    let config = PdfiumRenderConfig::new().with_height(1080);

    // Method 1: Rotate page before rendering

    let page_1 = document.page(0)?;

    assert!(!page_1.is_landscape());
    assert!(page_1.is_portrait());

    page_1.set_rotation(PdfiumRotation::Cw90);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-90-1.jpg", image::ImageFormat::Jpeg)?;

    assert!(page_1.is_landscape());

    page_1.set_rotation(PdfiumRotation::Cw180);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-180-1.jpg", image::ImageFormat::Jpeg)?;

    page_1.set_rotation(PdfiumRotation::Cw270);
    let bitmap = page_1.render(&config)?;
    bitmap.save("groningen-rotation-270-1.jpg", image::ImageFormat::Jpeg)?;

    // Method 2 (better): Use `with_rotation` when creating the `PdfiumRenderConfig`

    let page_2 = document.page(1)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw90))?;
    bitmap.save("groningen-rotation-90-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw180))?;
    bitmap.save("groningen-rotation-180-2.jpg", image::ImageFormat::Jpeg)?;

    let bitmap = page_2.render(&config.clone().with_rotation(PdfiumRotation::Cw270))?;
    bitmap.save("groningen-rotation-270-2.jpg", image::ImageFormat::Jpeg)?;

    // Return success - all operations were successful
    Ok(())
}

pub fn has_transparency(&self) -> bool

Checks if this PdfiumPage contains transparency.

Returns true if this contains transparency.

Trait Implementations

impl Clone for PdfiumPage

fn clone(&self) -> PdfiumPage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PdfiumPage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&PdfiumPage> for FPDF_PAGE

fn from(page: &PdfiumPage) -> Self

Converts to this type from the input type.