The docs claim that this crate depends on image ^0.23 and ships with it but running the code example produces this error:

extern crate printpdf;

use printpdf::*;
use std::io::Cursor;
use image_crate::bmp::BmpDecoder;
use std::fs::File;
use std::io::BufWriter;

fn main() {
    let (doc, page1, layer1) = PdfDocument::new("printpdf graphics test", Mm(210.0), Mm(297.0), "Layer 1");
    let current_layer = doc.get_page(page1).get_layer(layer1);

    // currently, the only reliable file formats are bmp/jpeg/png
    // this is an issue of the image library, not a fault of printpdf

    let image_bytes = include_bytes!("../assets/img/BMP_test.bmp");
    let mut reader = Cursor::new(image_bytes.as_ref());

    let decoder = BmpDecoder::new(&mut reader).unwrap();
    let image = Image::try_from(decoder).unwrap();

    let rotation_center_x = Px((image.image.width.0 as f64 / 2.0) as usize);
    let rotation_center_y = Px((image.image.height.0 as f64 / 2.0) as usize);

    // layer,
    image.add_to_layer(current_layer.clone(), ImageTransform {
        rotate: Some(ImageRotation {
            angle_ccw_degrees: 45.0,
            rotation_center_x,
            rotation_center_y,
        }),
        translate_x: Some(Mm(10.0)),
        translate_y: Some(Mm(10.0)),
        .. Default::default()
    });

    doc.save(&mut BufWriter::new(File::create("test_image.pdf").unwrap())).unwrap();
}

Error:

error[E0433]: failed to resolve: use of undeclared crate or module `image_crate`
 --> src/main.rs:5:5
  |
5 | use image_crate::bmp::BmpDecoder;
  |     ^^^^^^^^^^^ use of undeclared crate or module `image_crate`

The image crate no longer has image::bmp::BmpDecoder. It has been renamed to image::codecs::bmp::BmpDecoder. Okay, let's add the image crate manually and try again:

Cargo.toml:

[package]
name = "printpdf"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
printpdf = "0.5.0"
image = "0.23.0"

main.rs:

extern crate printpdf;

use printpdf::{ImageRotation, ImageTransform, Mm, Px, Image, PdfDocument};
use image::codecs::bmp::BmpDecoder;
use std::io::Cursor;
use std::fs::File;
use std::io::BufWriter;

fn main() {
    let (doc, page1, layer1) = PdfDocument::new("printpdf graphics test", Mm(210.0), Mm(297.0), "Layer 1");
    let current_layer = doc.get_page(page1).get_layer(layer1);

    // currently, the only reliable file formats are bmp/jpeg/png
    // this is an issue of the image library, not a fault of printpdf

    let image_bytes = include_bytes!("../assets/img/BMP_test.bmp");
    let mut reader = Cursor::new(image_bytes.as_ref());

    let decoder = BmpDecoder::new(&mut reader).unwrap();
    let image = Image::try_from(decoder).unwrap();

    let rotation_center_x = Px((image.image.width.0 as f64 / 2.0) as usize);
    let rotation_center_y = Px((image.image.height.0 as f64 / 2.0) as usize);

    // layer,
    image.add_to_layer(current_layer.clone(), ImageTransform {
        rotate: Some(ImageRotation {
            angle_ccw_degrees: 45.0,
            rotation_center_x,
            rotation_center_y,
        }),
        translate_x: Some(Mm(10.0)),
        translate_y: Some(Mm(10.0)),
        .. Default::default()
    });

    doc.save(&mut BufWriter::new(File::create("test_image.pdf").unwrap())).unwrap();
}

Error:

error[E0277]: the trait bound `printpdf::Image: From<BmpDecoder<&mut std::io::Cursor<_>>>` is not satisfied
  --> src/main.rs:20:17
   |
20 |     let image = Image::try_from(decoder).unwrap();
   |                 ^^^^^^^^^^^^^^^ the trait `From<BmpDecoder<&mut std::io::Cursor<_>>>` is not implemented for `printpdf::Image`
   |
   = help: the trait `From<ImageXObject>` is implemented for `printpdf::Image`
   = note: required because of the requirements on the impl of `Into<printpdf::Image>` for `BmpDecoder<&mut std::io::Cursor<_>>`
   = note: required because of the requirements on the impl of `TryFrom<BmpDecoder<&mut std::io::Cursor<_>>>` for `printpdf::Image`

For more information about this error, try `rustc --explain E0277`.

I just did

cargo run --example fonts

and then

firefox test_fonts.pdf

and the file is broken.

The same happens to us in production with external partner's pdf reader software.

printpdf currently uses rusttype 0.8 that is no longer maintained. I experimented with updating rusttype to 0.9. It seems to work fine, but I noticed that ab_glyph is rusttype’s more efficient successor (by the same author). Then I noticed that printpdf doesn’t really need rusttype or ab_glyph because they mainly deal with font rendering and rasterization. Instead it could directly use ttf-parser.

So my questions are:

• Is there a reason to stick with rusttype 0.8?
• If no, should printpdf
  • update to rusttype 0.9,
  • move to ab_glyph or
  • move to ttf-parser?

Hi. I'm trying to generate a pdf and insert an image, but it simply doesn't seem to work. The code is almost just a copy/paste from the documentaion. I do not have a pure linux machine, but I have tested it on windows and the windows subsystem for linux. In both cases the code compiles, runs, reads an image and produces a pdf document - albeit a completely empty one.

I have attached both the image I run the code with all well as the pdf I produce.

pdf-img.zip qrcodes.pdf

The code is located in a test and looks like this:

    #[tokio::test]
    async fn test_pdf() {
        let mut pdf_source = PathBuf::from(&env!("CARGO_MANIFEST_DIR").to_owned());
        pdf_source.push("out");
        pdf_source.push("codes");
        pdf_source.set_extension("pdf");

        let file = File::create(pdf_source).unwrap();

        log::debug!("Writing pdf to location: {:?}", file);

        let doc = make_pdf();
        let res = save_pdf(doc, file);

        assert!(res.is_ok());
    }

pub fn make_pdf() -> PdfDocumentReference { // qrcodes: Vec<QrCode>
	let (doc, page1, layer1) = PdfDocument::new("PDF_Document_title", Mm(210.0), Mm(297.0), "Layer 1");
    let current_layer = doc.get_page(page1).get_layer(layer1);

	// currently, the only reliable file format is bmp (jpeg works, but not in release mode)
    // this is an issue of the image library, not a fault of printpdf
    
    //let mut image_file = File::open("C:\\Users\\arbo\\Google Drive\\qrgithub\\assets\\pdf-img.bmp").unwrap();
    //let image = Image::try_from(image::bmp::BmpDecoder::new(&mut image_file).unwrap()).unwrap();
    let image_bytes = include_bytes!("/mnt/c/Users/arbo/Google Drive/qrgithub/assets/pdf-img.bmp");
    let mut reader = Cursor::new(image_bytes.as_ref());

    let decoder = BmpDecoder::new(&mut reader).unwrap();
    let image2 = Image::try_from(decoder).unwrap();

    log::debug!("decoded image: {:?}", image2);

    // translate x, translate y, rotate, scale x, scale y
    // by default, an image is optimized to 300 DPI (if scale is None)
    // rotations and translations are always in relation to the lower left corner
    image2.add_to_layer(current_layer, Some(Mm(100.0)), Some(Mm(100.0)), None, None, None, None);

	doc
}

pub fn save_pdf(doc: PdfDocumentReference, file: File) -> Result<(), Error> {
	let res = doc.save(&mut BufWriter::new(file));

	res
}

Hi,

For a project I need to know the width of a string for a given font and font size, so I can split the string into multiple lines, typically when the string is much wider than the page.

I checked the crate's documentation but I haven't found anything about it.

If this feature doesn't exist in this crate or one of its dependencies is there anything about getting at least the width of a char. If not what would be the best approach to solve this issue.

Thanks for the help.

Hi,

Thanks for the awesome library. One feature that I would really like is bookmarks in the pdf that you can put on a page. This bookmark shows up on the left of the page in firefox and is accessible on the kindle very easily with the goto menu. (The kindle is my use case.)

I do not know how simple this would be to implement, but it doesn't seem that hard.

Thanks so much.

for reference, here is how the feature looks in firefox (on the left there is a list of pages)

And if it helps, my use case is making a code renderer that can render source code for a project in a pdf file so it can be read on a kindle, so I would like it to be able to jump around quickly with bookmarks.

Edit:

Just saw this is in the TODOs. I could try to implement this if you could give me a little background, since I know very little about pdfs. I think there could be a function for a page called set_bookmark that just sets a bookmark on a page and accepts a &str for the name of the bookmark.

If I run

extern crate printpdf;

fn main() {
    println!("Hello, world!");
    use printpdf::*;
    use std::fs::File;
    use std::io::{self, BufRead, BufWriter};

    let (doc, page1, layer1) = PdfDocument::new("printpdf graphics test", Mm(210.0), Mm(297.0), "Layer 1");
    let current_layer = doc.get_page(page1).get_layer(layer1);
    let font = doc.add_external_font(File::open("OCRAStd.ttf").unwrap()).unwrap();
    let mut image_file = File::open("card-retro.bmp").unwrap();
    let image = Image::try_from(image::bmp::BMPDecoder::new(&mut image_file)).unwrap();
    image.add_to_layer(current_layer.clone(), Some(Mm(15.0)), Some(Mm(232.0)), None, None, None, Some(600.0));
    let fill_color = Color::Cmyk(Cmyk::new(0.0, 0.0, 0.0, 0.0, None));
    current_layer.set_fill_color(fill_color);
    let stdin = io::stdin();
    let nome = stdin.lock().lines().next().unwrap().unwrap();
    let lunghezza_nome = nome.len();
    current_layer.use_text(nome, 12, Mm(15.0+(85.6-85.6*(lunghezza_nome as f64)/28.0)/2.0), Mm(240.0), &font);
    current_layer.use_text("00001", 12, Mm(31.5), Mm(248.5), &font);
    current_layer.use_text("124912", 12, Mm(56.5), Mm(248.5), &font);
    // translate x, translate y, rotate, scale x, scale y
    // by default, an image is optimized to 300 DPI (if scale is None)
    // rotations and translations are always in relation to the lower left corner

    let mut image_file_retro = File::open("card-retro.bmp").unwrap();
    let image_retro = Image::try_from(image::bmp::BMPDecoder::new(&mut image_file_retro)).unwrap();

    // translate x, translate y, rotate, scale x, scale y
    // by default, an image is optimized to 300 DPI (if scale is None)
    // rotations and translations are always in relation to the lower left corner
    image_retro.add_to_layer(current_layer.clone(), Some(Mm(100.6)), Some(Mm(232.0)), None, None, None, Some(600.0));
    doc.save(&mut BufWriter::new(File::create("test_working.pdf").unwrap())).unwrap();
}

the image looks wrong (macOS Preview app loads it but it looks like it encoded about 10% of the image while Adobe Acrobat X complains that there isn't enough image data) The image above is what is shown in Preview.app test_working.pdf card-retro.bmp.zip

I'm trying out some of the examples, however the library does not seem willing to compile.

   Compiling printpdf v0.1.6
error[E0308]: mismatched types
   --> C:\Users\***\.cargo\registry\src\github.com-1ecc6299db9ec823\printpdf-0.1.6\src\types\pl
ugins\graphics\two_dimensional\font.rs:119:39
    |
119 |             ("Ascent".into(), Integer(face_metrics.ascender)),
    |                                       ^^^^^^^^^^^^^^^^^^^^^ expected i64, found i32

error[E0308]: mismatched types
   --> C:\Users\***\.cargo\registry\src\github.com-1ecc6299db9ec823\printpdf-0.1.6\src\types\pl
ugins\graphics\two_dimensional\font.rs:120:40
    |
120 |             ("Descent".into(), Integer(face_metrics.descender)),
    |                                        ^^^^^^^^^^^^^^^^^^^^^^ expected i64, found i32

error[E0308]: mismatched types
   --> C:\Users\***\.cargo\registry\src\github.com-1ecc6299db9ec823\printpdf-0.1.6\src\types\pl
ugins\graphics\two_dimensional\font.rs:121:42
    |
121 |             ("CapHeight".into(), Integer(face_metrics.ascender)),
    |                                          ^^^^^^^^^^^^^^^^^^^^^ expected i64, found i32

error[E0308]: mismatched types
   --> C:\Users\***\.cargo\registry\src\github.com-1ecc6299db9ec823\printpdf-0.1.6\src\types\pl
ugins\graphics\two_dimensional\font.rs:258:51
    |
258 |         let font_bbox = vec![ Integer(0), Integer(max_height), Integer(total_width as i64),
 Integer(max_height) ];
    |                                                   ^^^^^^^^^^ expected i64, found i32

error[E0308]: mismatched types
   --> C:\Users\***\.cargo\registry\src\github.com-1ecc6299db9ec823\printpdf-0.1.6\src\types\pl
ugins\graphics\two_dimensional\font.rs:258:101
    |
258 |         let font_bbox = vec![ Integer(0), Integer(max_height), Integer(total_width as i64),
 Integer(max_height) ];
    |
         ^^^^^^^^^^ expected i64, found i32

error: aborting due to 5 previous errors

error: Could not compile `printpdf`.

To learn more, run the command again with --verbose.

This can most likely be fixed pretty fast with type coercions.

I’m currently working on genpdf, a document generator and layout engine built on top of printpdf.

In #2, you wrote:

I'd also really like to do layout in a seperate library, not in printpdf - this library should only contain what the PDF spec says and contain the "primitives" for building a PDF. Anything fancy, like tables, page breaks, etc. should be done in a seperate library.

I think this applies to most features in genpdf, but there are some genpdf features that might be useful for printpdf:

• Measuring the width and height of strings *
• Kerning
• Transforming between the PDF coordinate system and the “logical” coordinate system (relative to the upper left corner)
• Views on a sub-area of a layer
• Text alignment (left/center/right/justified) *
• A TextSection type to ensure matching begin_text_section() and end_text_section() calls

* Edit: I just saw that you already said that you don’t want to include this in printpdf

Also, I plan to implement these features for genpdf that could be added to printpdf instead:

• Keeping track of the current settings (colors, spacing, line height, etc.) to avoid redundant operations

Are you interested in adding any of these features to printpdf?

Previously, PdfLayerReference::write_text would use the UTF-8 encoding for built-in fonts. But the built-in fonts only support a very limited set of encodings, see Appendix D of the PDF Reference [0]. When adding the font to the PDF document, printpdf already selects the WinAnsiEncoding (Windows-1252, see the Into implementation for BuiltinFont). This would lead to encoding issues for all non-ASCII characters, see also issue #30.

With this patch, we use lopdf::Document::encode_text to encode the text for built-in fonts with the WinAnsiEncoding. This fixes the encoding issues for built-in fonts. Note that that function just drops characters that are not supported by the encoding.

This patch also adds notes about this behaviour to the documentation of the add_builtin_font, use_text and write_text methods.

Fixes #30.

[0] https://www.adobe.com/content/dam/acom/en/devnet/pdf/pdfs/pdf_reference_archives/PDFReference.pdf

I'm trying to calculate how often x fits into y and would expect a float: let a: f64 = Mm(x) / Mm(y); But somehow it seems not possible. Is this not implemented? Is there a workaround? Or am I doing sth wrong? I have also problems when multiplying: let b: Mm = Mm(x) * y: f64

Hi! I am new to Rust. I want to show wasm generated pdf with live changes in browser.

How can I solve this shared reference problem? Is there a trait implementaion missing? How can I clone or take ownership of the doc? thank you.

Purpose:

to convert pdf to bytes array and sent to js side.

Code

use printpdf::*;
use serde::{Deserialize, Serialize};
use wasm_bindgen::prelude::*;

#[wasm_bindgen]
pub fn create() -> JsValue {
    let (doc, page1, layer1) =
        PdfDocument::new("PDF_Document_title", Mm(247.0), Mm(210.0), "Layer 1");

    let bytes: Vec<u8> = doc.save_to_bytes().unwrap();

    serde_wasm_bindgen::to_value(&bytes).unwrap()
}

Build Command

wasm-pack build --target bundler

Error

[INFO]: Checking for the Wasm target...
[INFO]: Compiling to Wasm...
   Compiling printpdf v0.5.3
error[E0507]: cannot move out of `m.modification_date` which is behind a shared reference
  --> /home/ulvi/.cargo/registry/src/github.com-1ecc6299db9ec823/printpdf-0.5.3/src/document_info.rs:77:56
   |
77 |         let info_mod_date = to_pdf_time_stamp_metadata(m.modification_date);
   |                                                        ^^^^^^^^^^^^^^^^^^^ move occurs because `m.modification_date` has type `js_sys_date::OffsetDateTime`, which does not implement the `Copy` trait

error[E0507]: cannot move out of `m.creation_date` which is behind a shared reference
  --> /home/ulvi/.cargo/registry/src/github.com-1ecc6299db9ec823/printpdf-0.5.3/src/document_info.rs:78:59
   |
78 |         let info_create_date = to_pdf_time_stamp_metadata(m.creation_date);
   |                                                           ^^^^^^^^^^^^^^^ move occurs because `m.creation_date` has type `js_sys_date::OffsetDateTime`, which does not implement the `Copy` trait

error[E0507]: cannot move out of `m.creation_date` which is behind a shared reference
  --> /home/ulvi/.cargo/registry/src/github.com-1ecc6299db9ec823/printpdf-0.5.3/src/xmp_metadata.rs:49:43
   |
49 |         let create_date = to_pdf_xmp_date(m.creation_date);
   |                                           ^^^^^^^^^^^^^^^ move occurs because `m.creation_date` has type `js_sys_date::OffsetDateTime`, which does not implement the `Copy` trait

error[E0507]: cannot move out of `m.modification_date` which is behind a shared reference
  --> /home/ulvi/.cargo/registry/src/github.com-1ecc6299db9ec823/printpdf-0.5.3/src/xmp_metadata.rs:50:49
   |
50 |         let modification_date = to_pdf_xmp_date(m.modification_date);
   |                                                 ^^^^^^^^^^^^^^^^^^^ move occurs because `m.modification_date` has type `js_sys_date::OffsetDateTime`, which does not implement the `Copy` trait

error[E0507]: cannot move out of `m.metadata_date` which is behind a shared reference
  --> /home/ulvi/.cargo/registry/src/github.com-1ecc6299db9ec823/printpdf-0.5.3/src/xmp_metadata.rs:51:45
   |
51 |         let metadata_date = to_pdf_xmp_date(m.metadata_date);
   |                                             ^^^^^^^^^^^^^^^ move occurs because `m.metadata_date` has type `js_sys_date::OffsetDateTime`, which does not implement the `Copy` trait

For more information about this error, try `rustc --explain E0507`.
error: could not compile `printpdf` due to 5 previous errors
Error: Compiling your crate to WebAssembly failed
Caused by: failed to execute `cargo build`: exited with exit status: 101
  full command: "cargo" "build" "--lib" "--release" "--target" "wasm32-unknown-unknown"

Hi! I wanted to know if this library supports RTL languages or not? In terms of writing and also in terms of layout and alignment.

If not, can you please tell me if there is a solution or if you know a library that has this feature?

ColorSpace is just a simplified version of ColorType and is not used much in this library codebase.

Replacing it with the color_type field in ImageXObject will give library users more information, in case they want to do some transformation with the field image_data.

For example, some people reported that adding an image with the Alpha channel will result in a blank page (#84, #119). This can be resolved by removing the alpha channel from ImageXObject::image_data (check this comment: https://github.com/fschutt/printpdf/issues/119#issuecomment-1120434233). However, for different color_type, image_data will have different formats. For ColorType::Rgba8, image_data will have format: [Red1, Green1, Blue1, Alpha1, ..., RedN, Green2, Blue2; AlphaN]. But for ColorType::Rgba16, the format will be [Red1a, Red1b, Green1a, Green1b, Blue1a, Blue1b, Alpha1a, Alpha1b, ...]. Source: https://github.com/image-rs/image/issues/1711#issuecomment-1120450753

Every time I try to decode a PNG file with PngDecoded and add it to the PDF page, the PDF page is blank.

My Rust code:

use printpdf::*;

use std::fs::File;
use std::io::BufWriter;

fn main() {
    let (doc, page1, layer1) =
        PdfDocument::new("PDF_Document_title", Mm(247.0), Mm(210.0), "Layer 1");
    let current_layer = doc.get_page(page1).get_layer(layer1);

    // currently, the only reliable file formats are bmp/jpeg/png
    // this is an issue of the image library, not a fault of printpdf
    let mut image_file = File::open("inputs/screenshot.png").unwrap();
    let image =
        Image::try_from(image_crate::codecs::png::PngDecoder::new(&mut image_file).unwrap())
            .unwrap();

    println!("{:?}", image.image);

    image.add_to_layer(current_layer.clone(), ImageTransform::default());

    doc.save(&mut BufWriter::new(File::create("output.pdf").unwrap()))
        .unwrap();
}

Cargo.toml:

[package]
name = "test_printpdf"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
printpdf = { version = "0.5", features = ["embedded_images"] }

The PNG file, inputs/screenshot.png:

The output PDF, output.pdf:

P/s: This problem does not happen when I decode JPEG files with JpegDecoder. Maybe it is only applied for PNG files

Currently, docs.rs doesn't show Image functions which are behind a "embedded_images" feature flag. Here is docs.rs's docs on how to enable it: https://docs.rs/about/metadata. I think adding this to Cargo.toml should work:

[package.metadata.docs.rs]
features = ["embedded_images"]