https://github.com/anowell/wkhtmltopdf-rs

High-level Rust bindings for wkhtmltopdf
https://github.com/anowell/wkhtmltopdf-rs

Last synced: 3 months ago
JSON representation

High-level Rust bindings for wkhtmltopdf

• Host: GitHub
• URL: https://github.com/anowell/wkhtmltopdf-rs
• Owner: anowell
• License: mit
• Archived: true
• Created: 2016-06-25T05:06:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-19T18:02:45.000Z (almost 2 years ago)
• Last Synced: 2024-08-06T07:25:14.117Z (3 months ago)
• Language: Rust
• Size: 731 KB
• Stars: 75
• Watchers: 5
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# wkhtmltopdf-rs

High-level Rust bindings for wkhtmltopdf. This is a wrapper around the low-level binding provided by [libwkhtmltox-sys](https://github.com/anowell/libwkhtmltox-sys).

Resource  | Link

----- | -----

Crate | [![Crates.io](https://img.shields.io/crates/v/wkhtmltopdf.svg?maxAge=2592000)](https://crates.io/crates/wkhtmltopdf)

Documentation | [Cargo docs](https://anowell.github.io/wkhtmltopdf-rs/wkhtmltopdf/)

Upstream | [wkhtmltopdf.org](http://wkhtmltopdf.org/)

-----

This crate aims to provide full configuration of wkhtmltopdf with safe, ergonomic Rust.

Wkhtmltopdf has several non-obvious limitations (mostly caused by Qt).

that make it very easy to cause undefined behavior with the C bindings.

Two such limitations that greatly impact the API are:

1. Wkhtmltopdf initialization can only occur once per process; deinitialization does make it safe to reuse

2. PDF generation must always occur on the thread that initialized wkhtmltopdf

This crate should make it impossible to break those rules in safe code. If you need parallel PDF generation,

you will need to spawn/fork processes to do so. Such an abstraction would be a welcome addition to this crate.

## Install

Install [wkhtmltopdf](http://wkhtmltopdf.org/downloads.html) 0.12.3.

Note: This library using the `libs` (shared objects) and `includes` (headers)

  for PDF generation instead of the wkhtmltopdf executable.

## Usage

Basic usage looks like this:

```rust

  let html = r#"
foo
"#;

  let mut pdf_app = PdfApplication::new().expect("Failed to init PDF application");

  let mut pdfout = pdf_app.builder()

      .orientation(Orientation::Landscape)

      .margin(Size::Inches(2))

      .title("Awesome Foo")

      .build_from_html(&html)

      .expect("failed to build pdf");


  pdfout.save("foo.pdf").expect("failed to save foo.pdf");

  println!("generated PDF saved as: foo.pdf");

```

## Build

As long as the includes are installed (e.g. `pdf.h`), then it's all cargo:

```

cargo build

cargo test

```

Note: tests have to be combined into a single test case because we can only init `PdfApplication` once, and it is `!Send`/`!Sync`.

So the preference going forward will be to test with a variety of good examples.

**Contributions welcome in the form of issue reports, feature requests, feedback, and/or pull request.**