48 releases
new 0.7.34 | Mar 15, 2023 |
---|---|
0.7.31 | Feb 22, 2023 |
0.7.27 | Dec 23, 2022 |
0.7.25 | Nov 12, 2022 |
0.5.5 | Feb 24, 2022 |
#18 in Images
2,329 downloads per month
Used in imcon
6.5MB
45K
SLoC
Idiomatic Rust bindings for Pdfium
pdfium-render
provides an idiomatic high-level Rust interface to Pdfium, the C++ PDF library
used by the Google Chromium project. Pdfium can render pages in PDF files to bitmaps, load, edit,
and extract text and images from existing PDF files, and create new PDF files from scratch.
use pdfium_render::prelude::*;
fn export_pdf_to_jpegs(path: &str, password: Option<&str>) -> Result<(), PdfiumError> {
// Renders each page in the PDF file at the given path to a separate JPEG file.
// Bind to a Pdfium library in the same directory as our Rust executable;
// failing that, fall back to using a Pdfium library provided by the operating system.
let pdfium = Pdfium::new(
Pdfium::bind_to_library(Pdfium::pdfium_platform_library_name_at_path("./"))
.or_else(|_| Pdfium::bind_to_system_library())?,
);
// Load the document from the given path...
let document = pdfium.load_pdf_from_file(path, password)?;
// ... set rendering options that will be applied to all pages...
let render_config = PdfRenderConfig::new()
.set_target_width(2000)
.set_maximum_height(2000)
.rotate_if_landscape(PdfBitmapRotation::Degrees90, true);
// ... then render each page to a bitmap image, saving each image to a JPEG file.
for (index, page) in document.pages().iter().enumerate() {
page.render_with_config(&render_config)?
.as_image() // Renders this page to an image::DynamicImage...
.as_rgba8() // ... then converts it to an image::Image...
.ok_or(PdfiumError::ImageError)?
.save_with_format(
format!("test-page-{}.jpg", index),
image::ImageFormat::Jpeg
) // ... and saves it to a file.
.map_err(|_| PdfiumError::ImageError)?;
}
Ok(())
}
pdfium-render
binds to a Pdfium library at run-time, allowing for flexible selection of
system-provided or bundled Pdfium libraries and providing idiomatic Rust error handling in
situations where a Pdfium library is not available. A key advantage of binding to Pdfium at run-time
rather than compile-time is that a Rust application using pdfium-render
can be compiled to WASM
for running in a browser alongside a WASM-packaged build of Pdfium.
pdfium-render
aims to eventually provide bindings to all non-interactive functionality provided
by Pdfium. This is a work in progress that will be completed by version 1.0 of this crate.
Examples
Short, commented examples that demonstrate all the major Pdfium document handling features are available at https://github.com/ajrcarey/pdfium-render/tree/master/examples. These examples demonstrate:
- Rendering pages to bitmaps.
- Text and image extraction.
- Form field introspection.
- Document signature introspection.
- Document attachment creation and introspection.
- Document concatenation.
- Page object introspection.
- Page annotation introspection.
- Page link introspection.
- Creation of new documents and new pages.
- Creation of page objects for text, paths, and bitmaps.
- Page object transformation.
- Multi-page tiled output.
- Watermarking.
- Thread safety.
- Compiling to WASM.
What's new
Note: Upcoming release 0.8.0 will include a breaking change. The PdfDocument::pages()
function,
which currently returns an owned PdfPages
instance, will be changed so that it returns
an immutable &PdfPages
reference instead. A new PdfDocument::pages_mut()
function
will return a mutable &mut PdfPages
reference. It will no longer be possible to retrieve
an owned PdfPages
instance. For the motivation behind this change, see
https://github.com/ajrcarey/pdfium-render/issues/47.
Version 0.7.34 adds support for reading values from form fields wrapped inside the newly added
PdfPageWidgetAnnotation
and PdfPageXfaWidgetAnnotation
annotation objects. Also added are
the PdfFormField
enum and its variants, and various supporting structs for handling form
field values. A map containing all form field names and values can be retrieved via the new
PdfForm::field_values()
function. examples/form_fields.rs
demonstrates the new functionality.
Version 0.7.33 adds the PdfPage::transform()
, PdfPage::transform_with_clip()
, and
PdfPage::set_matrix_with_clip()
functions, allowing the page objects on a page to be transformed
in a single operation, and adds transformation functions to PdfMatrix
, making it easy to
"queue up" a set of transformations that can be applied to any transformable object via the
object's set_matrix()
function. examples/matrix.rs
demonstrates the new functionality.
Version 0.7.32 fixes off-by-one errors in PdfPageText::chars_inside_rect()
and examples/chars.rs
thanks to an excellent contribution from https://github.com/luketpeterson, and adds support
for grayscale image processing to PdfPageImageObject
thanks to an excellent contribution
from https://github.com/stephenjudkins.
Version 0.7.31 adds the PdfPageLinks
collection, the PdfPage::links()
and PdfPage::links_mut()
functions, the PdfLink
and PdfDestination
structs, and fleshes out the implementation of
PdfAction
. It is now possible to retrieve the URI of an action associated with a link using the
PdfActionUri::uri()
function. examples/links.rs
demonstrates the new functionality.
Version 0.7.30 corrects a potential use-after-free error in the high level interface by deprecating
the PdfPages::delete_page_at_index()
and PdfPages::delete_page_range()
functions in favour of
the new PdfPage::delete()
function. (Previously, it was possible to hold a PdfPage
reference
after deleting the page from the containing PdfPages
collection.) Deprecated items will be removed
in release 0.9.0.
Binding to Pdfium
pdfium-render
does not include Pdfium itself. You have several options:
- Bind to a dynamically-built Pdfium library provided by the operating system.
- Bind to a dynamically-built Pdfium library packaged alongside your Rust executable.
- Bind to a statically-built Pdfium library linked to your executable at compile time.
When compiling to WASM, packaging an external build of Pdfium as a separate WASM module is essential.
Dynamic linking
Binding to a pre-built Pdfium dynamic library at runtime is the simplest option. On Android, a pre-built
libpdfium.so
is packaged as part of the operating system (although recent versions of Android no
longer permit user applications to access it); alternatively, you can package a dynamic library
appropriate for your operating system alongside your Rust executable.
Pre-built Pdfium dynamic libraries suitable for runtime binding are available from several sources:
- Native (i.e. non-WASM) builds of Pdfium for all major platforms: https://github.com/bblanchon/pdfium-binaries/releases
- Android, iOS, macOS, and WASM builds of Pdfium: https://github.com/paulocoutinhox/pdfium-lib/releases
If you are compiling a native (i.e. non-WASM) build, and you place an appropriate Pdfium library in the same folder as your compiled application, then binding to it at runtime is as simple as:
use pdfium_render::prelude::*;
let pdfium = Pdfium::new(
Pdfium::bind_to_library(Pdfium::pdfium_platform_library_name_at_path("./")).unwrap()
);
A common pattern used in the examples at https://github.com/ajrcarey/pdfium-render/tree/master/examples is to first attempt to bind to a Pdfium library in the same folder as the compiled example, and attempt to fall back to a system-provided library if that fails:
use pdfium_render::prelude::*;
let pdfium = Pdfium::new(
Pdfium::bind_to_library(Pdfium::pdfium_platform_library_name_at_path("./"))
.or_else(|_| Pdfium::bind_to_system_library())
.unwrap() // Or use the ? unwrapping operator to pass any error up to the caller
);
Static linking
The static
crate feature offers an alternative to dynamic linking if you prefer to link Pdfium
directly into your executable at compile time. This enables the Pdfium::bind_to_statically_linked_library()
function which binds directly to the Pdfium functions compiled into your executable:
use pdfium_render::prelude::*;
let pdfium = Pdfium::new(Pdfium::bind_to_statically_linked_library().unwrap());
As a convenience, pdfium-render
can instruct cargo
to link a statically-built Pdfium
library for you. Set the path to the directory containing your pre-built library using
the PDFIUM_STATIC_LIB_PATH
environment variable when you run cargo build
, like so:
PDFIUM_STATIC_LIB_PATH="/path/containing/your/static/pdfium/library" cargo build
pdfium-render
will pass the following flags to cargo
:
cargo:rustc-link-lib=static=pdfium
cargo:rustc-link-search=native=$PDFIUM_STATIC_LIB_PATH
This saves you writing a custom build.rs
yourself. If you have your own build pipeline
that links Pdfium statically into your executable, simply leave the PDFIUM_STATIC_LIB_PATH
environment variable unset.
Note that the path you set in PDFIUM_STATIC_LIB_PATH
should not include the filename of the
library itself; it should just be the path of the containing directory. You must make sure your
statically-built library is named in the appropriate way for your target platform
(libpdfium.a
on Linux and macOS, for example) in order for the Rust compiler to locate it.
Depending on how your Pdfium library was built, you may need to also link against a C++ standard library.
To link against the GNU C++ standard library (libstdc++
), use the optional libstdc++
feature.
pdfium-render
will pass the following additional flag to cargo
:
cargo:rustc-link-lib=dylib=stdc++
To link against the LLVM C++ standard library (libc++
), use the optional libc++
feature.
pdfium-render
will pass the following additional flag to cargo
:
cargo:rustc-link-lib=dylib=c++
Alternatively, use the link-cplusplus
crate to link against a C++ standard library. link-cplusplus
offers more options for deciding which standard library should be selected, including automatically
selecting the build platform's installed default.
pdfium-render
will not build Pdfium for you; you must build Pdfium yourself, or source a
pre-built static archive from elsewhere. For an overview of the build process, including a sample
build script, see https://github.com/ajrcarey/pdfium-render/issues/53.
Compiling to WASM
See https://github.com/ajrcarey/pdfium-render/tree/master/examples for a full example that shows
how to bundle a Rust application using pdfium-render
alongside a pre-built Pdfium WASM module for
inspection and rendering of PDF files in a web browser.
Certain functions that access the file system are not available when compiling to WASM. In all cases, browser-specific alternatives are provided, as detailed at the link above.
At the time of writing, the WASM builds of Pdfium at https://github.com/bblanchon/pdfium-binaries/releases are compiled with a non-growable WASM heap memory allocator. This means that attempting to open a PDF document longer than just a few pages will result in an unrecoverable out of memory error. The WASM builds of Pdfium at https://github.com/paulocoutinhox/pdfium-lib/releases are recommended as they do not have this problem.
Multithreading
Pdfium makes no guarantees about thread safety and should be assumed not to be thread safe. The Pdfium authors specifically recommend that parallel processing, not multi-threading, be used to process multiple documents simultaneously.
pdfium-render
achieves thread safety by locking access to Pdfium behind a mutex;
each thread must acquire exclusive access to this mutex in order to make any call to Pdfium.
This has the effect of sequencing all calls to Pdfium as if they were single-threaded,
even when using pdfium-render
from multiple threads. This approach offers no performance benefit,
but it ensures that Pdfium will not crash when running as part of a multi-threaded application.
An example of safely using pdfium-render
as part of a multithreaded parallel iterator is
available at https://github.com/ajrcarey/pdfium-render/tree/master/examples.
Crate features
This crate provides the following optional features:
bindings
: usescbindgen
to generate Rust bindings to the Pdfium functions defined in theinclude/*.h
files each timecargo build
is run. Ifcbindgen
or any of its dependencies are not available then the build will fail.image
: controls whether theimage
crate should be used bypdfium-render
to provide page and page object rendering functionality. Projects that do not require page or page object rendering can avoid having to include theimage
crate in their binaries.libstdc++
: links against the GNU C++ standard library when compiling. Requires thestatic
feature. See the "Static linking" section above.libc++
: links against the LLVM C++ standard library when compiling. Requires thestatic
feature. See the "Static linking" section above.static
: enables binding to a statically-linked build of Pdfium. See the "Static linking" section above.sync
: provides an implementation of theSend
andSync
traits for thePdfium
struct. This allows aPdfium
instance to be shared across threads. This is particularly useful for creating a static instance that can be used withlazy_static
oronce_cell
. Requires thethread_safe
feature.thread_safe
: wraps access to Pdfium behind a mutex to ensure thread-safe access to Pdfium. See the "Multithreading" section above.
The image
and thread_safe
features are enabled by default. All other features are disabled by default.
Porting existing Pdfium code from other languages
The high-level idiomatic Rust interface provided by pdfium-render
is built on top of
raw FFI bindings defined in the PdfiumLibraryBindings
trait. It is completely feasible to use
these raw FFI bindings directly if you wish, making porting existing code that calls FPDF_*
functions
trivial while still gaining the benefits of late binding and WASM compatibility.
For instance, the following code snippet (taken from a C++ sample):
string test_doc = "test.pdf";
FPDF_InitLibrary();
FPDF_DOCUMENT doc = FPDF_LoadDocument(test_doc, NULL);
// ... do something with doc
FPDF_CloseDocument(doc);
FPDF_DestroyLibrary();
would translate to the following Rust code:
let bindings = Pdfium::bind_to_system_library().unwrap();
let test_doc = "test.pdf";
bindings.FPDF_InitLibrary();
let doc = bindings.FPDF_LoadDocument(test_doc, None);
// ... do something with doc
bindings.FPDF_CloseDocument(doc);
bindings.FPDF_DestroyLibrary();
Pdfium's API uses three different string types: classic C-style null-terminated char arrays,
UTF-8 byte arrays, and a UTF-16LE byte array type named FPDF_WIDESTRING
. For functions that take a
C-style string or a UTF-8 byte array, pdfium-render
's binding will take the standard Rust &str
type.
For functions that take an FPDF_WIDESTRING
, pdfium-render
exposes two functions: the vanilla
FPDF_*()
function that takes an FPDF_WIDESTRING
, and an additional FPDF_*_str()
helper function
that takes a standard Rust &str
and converts it internally to an FPDF_WIDESTRING
before calling
Pdfium. Examples of functions with additional _str()
helpers include FPDFBookmark_Find()
,
FPDFText_SetText()
, FPDFText_FindStart()
, FPDFDoc_AddAttachment()
, FPDFAnnot_SetStringValue()
,
and FPDFAttachment_SetStringValue()
.
The PdfiumLibraryBindings::get_pdfium_utf16le_bytes_from_str()
and
PdfiumLibraryBindings::get_string_from_pdfium_utf16le_bytes()
utility functions are provided
for converting to and from FPDF_WIDESTRING
in your own code.
Some Pdfium functions return classic C-style integer boolean values, aliased as FPDF_BOOL
.
The PdfiumLibraryBindings::TRUE()
, PdfiumLibraryBindings::FALSE()
,
PdfiumLibraryBindings::is_true()
, and PdfiumLibraryBindings::bool_to_pdfium()
utility functions
are provided for converting to and from FPDF_BOOL
in your own code.
Image pixel data in Pdfium is encoded in either three-channel BGR or four-channel BGRA.
The PdfiumLibraryBindings::bgr_to_rgba()
, PdfiumLibraryBindings::bgra_to_rgba()
,
PdfiumLibraryBindings::rgb_to_bgra()
, and PdfiumLibraryBindings::rgba_to_bgra()
utility functions
are provided for converting between RGB and BGR image data in your own code.
Development status
The initial focus of this crate was on rendering pages in a PDF file; consequently, FPDF_*
functions related to page rendering were prioritised. By 1.0, the functionality of all
FPDF_*
functions exported by all Pdfium modules will be available, with the exception of certain
functions specific to interactive scripting, user interaction, and printing.
- Releases numbered 0.4.x added support for all page rendering Pdfium functions to
pdfium-render
. - Releases numbered 0.5.x-0.6.x added support for most read-only Pdfium functions to
pdfium-render
. - Releases numbered 0.7.x aim to progressively add support for all Pdfium page object creation and editing functions to
pdfium-render
. - Releases numbered 0.8.x aim to progressively add support for all other Pdfium editing functions to
pdfium-render
. - Releases numbered 0.9.x aim to fill any remaining gaps in the high-level interface prior to 1.0.
By version 0.8.0, pdfium-render
should provide useful coverage for the vast majority of common
use cases, whether rendering existing documents or creating new ones.
There are 368 FPDF_*
functions in the Pdfium API. As of version 0.7.34, 323 (88%) have
bindings available in PdfiumLibraryBindings
, with the functionality of the majority of these
available via the pdfium-render
high-level interface.
Some functions and type definitions in the high-level interface have been renamed or revised since their initial implementation. The initial implementations are still available but are marked as deprecated. These deprecated items will be removed in release 0.9.0.
If you need a binding to a Pdfium function that is not currently available, just raise an issue at https://github.com/ajrcarey/pdfium-render/issues.
Version history
- 0.7.34: replaces functions in
PdfPageLinks
using linear traversal with binary search traversal; adds newPdfFormField
enum; renamesPdfPageObjectFormFragment
toPdfPageXObjectFormObject
to disambiguate it fromPdfForm
andPdfFormField
, andPdfFormFields
; addsPdfPageAnnotationCommon::as_form_field()
accessor function; adds form field structsPdfFormPushButtonField
,PdfFormCheckboxField
,PdfFormComboBoxField
,PdfFormListBoxField
,PdfFormRadioButtonField
,PdfFormSignatureField
,PdfFormTextField
, andPdfFormUnknownField
; addsPdfFormFieldOption
struct andPdfFormFieldOptions
collection, for retrieving the options displayed within a list box or combo box field; addsPdfFormFieldCommon
andPdfFormFieldPrivate
traits and associated implementations; adds thePdfForm::field_values()
convenience function; addsexamples/form_fields.rs
example. - 0.7.33: adds the
create_transform_setters!()
andcreate_transform_getters!()
private macros, ensuring API consistency and maximising code reuse across all transformable objects; addsPdfPage::transform()
,PdfPage::transform_with_clip()
, andPdfPage::set_matrix_with_clip()
functions; addsexamples/matrix.rs
example; adds bindings for remainingFPDF_*ClipPath*()
functions. - 0.7.32: fixes off-by-one errors in
PdfPageText::chars_inside_rect()
andexamples/chars.rs
thanks to an excellent contribution from https://github.com/luketpeterson, adds support for grayscale image processing toPdfPageImageObject::get_image_from_bitmap_handle()
thanks to an excellent contribution from https://github.com/stephenjudkins, and corrects a missing dependency when usingpdfium-render
without the defaultimage
crate feature. - 0.7.31: adds the
PdfPageLinks
collection, thePdfPage::links()
andPdfPage::links_mut()
functions, thePdfLink
andPdfDestination
structs, thePdfActionCommon
andPdfActionPrivate
traits, structs for the action types supported by Pdfium, thePdfActionUri::uri()
function to address https://github.com/ajrcarey/pdfium-render/issues/68, and the newexamples/links.rs
example. - 0.7.30: deprecates the
PdfPages::delete_page_at_index()
andPdfPages::delete_page_range()
functions; addsPdfPage::delete()
function in response to https://github.com/ajrcarey/pdfium-render/issues/67. Deprecated items will be removed in release 0.9.0, although it may be possible to restore these functions if safer reference handling inPdfDocument
andPdfPages
is introduced as part of https://github.com/ajrcarey/pdfium-render/issues/47. - 0.7.29: removes the
sync
crate feature from the list of default crate features in response to https://github.com/ajrcarey/pdfium-render/issues/66. - 0.7.28: removes the
PdfPageObjects::take_*()
functions; addsPdfPageObject::is_copyable()
PdfPageObject::try_copy()
,PdfPageObjectGroup::retain()
,PdfPageObjectGroup::retain_if_copyable()
,PdfPageObjectGroup::is_copyable()
,PdfPageObjectGroup::try_copy_onto_existing_page()
,PdfPageObjectGroup::copy_onto_new_page_at_start()
,PdfPageObjectGroup::copy_onto_new_page_at_end()
, andPdfPageObjectGroup::copy_onto_new_page_at_index()
functions; addsexamples/copy_objects.rs
example; fixes a bug in the propagation of a page's content regeneration strategy; removes all use oflazy_static!
macro in favour ofonce_cell::sync::Lazy
. - 0.7.27: adjusts
examples/index.html
to take into account upstream packaging changes in the WASM builds of Pdfium published at https://github.com/paulocoutinhox/pdfium-lib/releases; adds theimage
crate feature. - 0.7.26: adds
sync
default crate feature providingSend
andSync
implementations forPdfium
struct; addsDisplay
andError
trait implementations toPdfiumError
foranyhow
compatibility; adjusts WASM example to account for upstream changes in Emscripten packaging of Pdfium WASM builds; corrects a lifetime problem inPdfium::load_pdf_from_bytes()
and deprecatesPdfium::load_pdf_from_bytes()
in favour ofPdfium::load_pdf_from_byte_slice()
andPdfium::load_pdf_from_byte_vec()
. Deprecated items will be removed in release 0.9.0. - 0.7.25: adds the
PdfPageAnnotationObjects
collection and thePdfPageAnnotation::objects()
,PdfPageInkAnnotation::objects_mut()
, andPdfPageStampAnnotation::objects_mut()
functions to the high-level interface. - 0.7.24: adds bindings for
FPDFClipPath_CountPathSegments()
,FPDFClipPath_GetPathSegment()
,FPDFPath_CountSegments()
,FPDFPath_GetPathSegment()
, andFPDFPathSegment_*()
functions; addsPdfFontGlyphs
andPdfPagePathObjectSegments
collections to the high-level interface, along with accessor functions inPdfFont
andPdfPagePathObject
; adds thePdfPathSegments
trait; introduces some infrastructure necessary for the future implementation of aPdfClipPath
object; addsPdfPages::first()
,PdfPages::last()
, andPdfPage::fonts()
convenience functions. - 0.7.23: removes some unnecessary mutable bindings in
PdfBitmap
; uses#[cfg(doc)]
declarations to ensurecargo doc
generates documentation for all functionality, irrespective of the platform. - 0.7.22: attempts to work around two problems in Pdfium's bitmap generation when retrieving processed renderings of page image objects. See https://github.com/ajrcarey/pdfium-render/issues/52 for more information.
- 0.7.21: adds bindings for
FPDF_GetPageAAction()
,FPDF_GetFileIdentifier()
, and all remainingFPDFDest_*()
andFPDFLink_*()
functions; addsPdfAttachment::len()
andPdfAttachment::is_empty()
convenience functions; addslibstdc++
andlibc++
crate features; adds color conversion functions toPdfiumLibraryBindings
; corrects bugs in color conversion when working withPdfPageImageObject
, as detailed in https://github.com/ajrcarey/pdfium-render/issues/50; fixes a bug in the WASM implementation ofFPDFAnnot_GetAttachmentPoints()
; corrects some small typos in examples. - 0.7.20: adds bindings for
FPDFPage_*Thumbnail*()
,FPDFLink_*()
, andFPDFText_Find*()
functions; addsPdfAttachments::create_attachment_from_bytes()
,PdfAttachments::create_attachment_from_file()
,PdfAttachments::create_attachment_from_reader()
,PdfAttachments::create_attachment_from_fetch()
,
PdfAttachments::create_attachment_from_blob()
,PdfAttachments::delete_at_index()
,PdfAttachment::save_to_writer()
,PdfAttachment::save_to_file()
,PdfAttachment::save_to_blob()
,PdfPage::has_embedded_thumbnail()
,PdfPage::embedded_thumbnail()
, andPdfPage::boundaries_mut()
functions to the high-level interface; renamesPdfAttachment::bytes()
function introduced in 0.7.19 toPdfAttachment::save_to_bytes()
. - 0.7.19: adds bindings for
FPDFDoc_*Attachment*()
functions; addsPdfAttachments
andPdfSignatures
collections to the high-level interface. - 0.7.18: adds convenience
bindings()
accessor functions toPdfDocument
,PdfPage
,PdfBitmap
,PdfFont
, and various other interfaces, thanks to an excellent contribution from https://github.com/LU15W1R7H; deprecatesPdfium::get_bindings()
in favour ofPdfium::bindings()
for consistency. Deprecated items will be removed in release 0.9.0. - 0.7.17: relaxes some unnecessarily restrictive lifetime bounds in
PdfPageObjectPath
. - 0.7.16: adds
PdfPageObjects::create_path_object_bezier()
andPdfPageObjectPath::new_bezier()
convenience functions; corrects some typos in documentation. - 0.7.15: adds
PdfPageAnnotationCommon::name()
,PdfPageAnnotationCommon::contents()
,PdfPageAnnotationCommon::author()
,PdfPageAnnotationCommon::creation_date()
, andPdfPageAnnotationCommon::modification_date()
functions for working with annotations; addsPdfPageText::for_annotation()
andPdfPageText::chars_for_annotation()
for more easily extracting text and characters associated with annotations; addsexamples/annotations.rs
andexamples/image_extract.rs
; renamesexamples/text.rs
toexamples/text_extract.rs
. - 0.7.14: fixes a bug in the WASM implementation of
FPDF_StructElement_GetStringAttribute()
; pins required version ofimage
crate to at least 0.24.0 or later to avoid incompatibility between theimage::DynamicImage
trait definitions in 0.23.x and 0.24.x; adds compatibility with web workers to the WASM implementation, thanks to an excellent contribution from https://github.com/NyxCode. - 0.7.13: adds transformation and clipping functions to
PdfRenderConfig
; adds bindings forFPDF_RenderPageBitmapWithMatrix()
; deprecatesPdfRenderConfig::rotate_if_portait()
in favour of the correctly-spelledPdfRenderConfig::rotate_if_portrait()
. Deprecated items will be removed in release 0.9.0. - 0.7.12: adds
PdfPage::render_into_bitmap()
andPdfPage::render_into_bitmap_with_config()
functions for higher performance; deprecatesPdfPage::get_bitmap()
in favour ofPdfPage::render()
; deprecatesPdfPage::get_bitmap_with_config()
in favour ofPdfPage::render_with_config()
; deprecatesPdfBitmapConfig
in favour ofPdfRenderConfig
; deprecatesPdfBitmap::render()
as the function is no longer necessary. Deprecated items will be removed in release 0.9.0. - 0.7.11: adds the new WASM-specific
PdfBitmap::as_array()
function as a higher performance alternative to the cross-platformPdfBitmap::as_bytes()
function, thanks to an excellent contribution from https://github.com/NyxCode. - 0.7.10: corrects some typos in documentation; adds additional constructors to
PdfPageImageObject
that apply a specified width and/or height at object creation time. - 0.7.9: adds retrieval of the list of image filters applied to a
PdfPageImageObject
; adds thePdfColorSpace
enum; adds bindings for theFPDF_*Signature*()
,FPDFSignatureObj_*()
, andFPDF_StructTree_*()
functions. - 0.7.8: adds image support to the
PdfPageImageObject
struct, thePdfPageObjects::add_image_object()
andPdfPageObjects::create_image_object()
functions, additional convenience functions for loading fonts from files and readers toPdfFont
, and bindings forFPDF_VIEWERREF_Get*()
functions. - 0.7.7: adds the
thread_safe
crate feature and the accompanying example inexamples/thread_safe.rs
. - 0.7.6: adds retrieval of text settings on a character-by-character basis to the
PdfPageText
andPdfPageTextObject
objects; addsPdfPageTextSegment
andPdfPageTextChar
structs to the high-level interface; adds retrieval of current transformation settings to all page objects; adds thePdfPageTextObject::scaled_font_size()
function and renamesPdfPageTextObject::font_size()
toPdfPageTextObject::unscaled_font_size()
as these names make clearer the differences between scaled and unscaled font sizes in text objects; adds bindings for all remainingFPDFText_*()
functions. - 0.7.5: corrects a bug in error handling on Windows. See https://github.com/ajrcarey/pdfium-render/issues/24 for more information.
- 0.7.4: adds the
PdfPageGroupObject::remove_objects_from_page()
function; renamedPdfPageObjects::delete_object()
andPdfPageObjects::delete_object_at_index()
functions toPdfPageObjects::remove_object()
andPdfPageObjects::remove_object_at_index()
as these names better reflect the underlying operation that occurs. - 0.7.3: corrects a bug in the implementation of
PdfPages::append()
introduced in 0.7.2. - 0.7.2: adds object groups for manipulating and transforming groups of page objects as if they
were a single object, and the
PdfPages::watermark()
function for applying individualized watermarks to any or all pages in a document. Fixes a potential double-free bug inPdfFont::drop()
. - 0.7.1: adds path segment creation to the
PdfPagePathObject
object, convenience functions for quickly creating rectangles, ellipses, and circles, and thePdfPageObjects::add_path_object()
function. - 0.7.0: adds
PdfPermissions
collection, adds document loading and saving support, adds initial creation and editing support for documents, pages, and text objects, and improves WASM document file handling. - 0.6.0: fixes some typos in documentation, updates upstream Pdfium WASM package source repository name.
- 0.5.9: corrects a bug in the statically linked bindings implementation. Adjusted tests to cover both dynamic and statically linked bindings implementations.
- 0.5.8: corrects a bug in the WASM implementation of certain
FPDFAnnot_*()
functions. Resolves a potential memory leak affecting the WASM implementation of variousFPDF_*()
functions. - 0.5.7: adds support for binding to a statically-linked build of Pdfium, adds
bindgen
andstatic
crate features. - 0.5.6: adds
pdfium_render::prelude
, adds bindings forFPDFAnnot_*()
andFPDFPage_*Annot*()
functions, addsPdfPageAnnotations
collection andPdfPageAnnotation
struct to the high-level interface. - 0.5.5: fixes two bugs in the WASM implementation, one to do with colors, one to do with text extraction. See https://github.com/ajrcarey/pdfium-render/issues/9 and https://github.com/ajrcarey/pdfium-render/issues/11 for more information.
- 0.5.4: changes default setting of
PdfBitmapConfig::set_reverse_byte_order()
totrue
to switch from Pdfium's default BGRA8 pixel format to RGBA8. This is necessary since theimage
crate dropped support for BGRA8 in version 0.24. See https://github.com/ajrcarey/pdfium-render/issues/9 for more information. - 0.5.3: adds bindings for
FPDFBookmark_*()
,FPDFPageObj_*()
,FPDFText_*()
, andFPDFFont_*()
functions, addsPdfPageObjects
,PdfPageText
, andPdfBookmarks
collections to the high-level interface. - 0.5.2: adds bindings for
FPDF_GetPageBoundingBox()
,FPDFDoc_GetPageMode()
,FPDFPage_Get*Box()
, andFPDFPage_Set*Box()
functions, addsPdfPageBoundaries
collection to the high-level interface. - 0.5.1: adds bindings for
FPDFPage_GetRotation()
andFPDFPage_SetRotation()
functions, addsPdfMetadata
collection to the high-level interface. - 0.5.0: adds rendering of annotations and form field elements, thanks to an excellent contribution from https://github.com/inzanez.
- 0.4.2: bug fixes in
PdfBitmapConfig
implementation. - 0.4.1: improvements to documentation and READMEs.
- 0.4.0: initial release of minimal page rendering functionality.
Dependencies
~19MB
~266K SLoC