Simple PDF Generator

Rust library that converts HTML5 files to PDFs. That's the Rust version of simple-pdf-generator

Installation

This is a Rust library available through crates.io.

Installation is done using cargo add command:

sh $ cargo add simple_pdf_generator

Features

Simple PDF Generator:

Limitations

Quick Start

In order to have a template you must create struct with PdfTemplate derive:

```rust use simplepdfgenerator::{Asset, AssetType}; use simplepdfgenerator_derive::PdfTemplate;

struct Example { id: i64, name: Option, optvalue: Option, surname: String, istrue: bool, } ```

And add the HTML file:

```html 

<body>
    <div class="container">
        <div class="row">
            <div class="col">Id</div>
            <div class="col">%%id%%</div>

            <div class="col">Name</div>
            <div class="col">%%name%%</div>

            <div class="col">Opt Value</div>
            <div class="col">%%opt_value%%</div>

            <div class="col">Surname</div>
            <div class="col">%%surname%%</div>

            <div class="col">Is True</div>
            <div class="col">%%is_true%%</div>
        </div>
    </div>
</body>

```

Now you can use the Example struct to generate the PDF file:

```rust use std::env;

use simplepdfgenerator::{Asset, AssetType}; use simplepdfgenerator_derive::PdfTemplate;

[tokio::main]

async fn main() { // fill the struct let example = Example { id: 1, name: Some("Foo".tostring()), optvalue: None, surname: "Bar".tostring(), istrue: true, };

// get the html template path
let html_path = env::current_dir()
    .unwrap()
    .join("test_suite")
    .join("src/template/index.html");

// inject some assets, in this case the bootstrap css
let assets = [Asset {
    path: env::current_dir()
        .unwrap()
        .join("test_suite")
        .join("src/template/css/bootstrap.min.css"),
    r#type: AssetType::Style,
}];

// generate the pdf file
let pdf_buf = example.generate_pdf(html_path, &assets).await;
tokio::fs::write("example.pdf", pdf_buf).await.expect("Unable to write file");

} ```

Generate Tables

To generate a table you must to use the PdfTableData macro on your data property:

```rust use std::env;

use serde::Serialize; use simplepdfgenerator::{Asset, AssetType}; use simplepdfgenerator_derive::PdfTemplate;

struct Example { id: i64, name: Option, optvalue: Option, surname: String, istrue: bool, #[PdfTableData] my_table: Vec, }

[derive(Serialize)]

struct MyTableData { index: u8, name: String, surname: String, email: String, }

[tokio::main]

async fn main() { // fill the struct let example = Example { id: 1, name: Some("Foo".tostring()), optvalue: None, surname: "Bar".tostring(), istrue: true, mytable: vec![ MyTableData { index: 1, name: "James".tostring(), surname: "Smith".tostring(), email: "james.smith@evilcorp.tech".tostring(), }, MyTableData { index: 2, name: "Robert".tostring(), surname: "Johnson".tostring(), email: "robert.johnson@evilcorp.tech".to_string(), }, ], };

// get the html template path
let html_path = env::current_dir()
    .unwrap()
    .join("test_suite")
    .join("src/template/index.html");

// inject some assets, in this case the bootstrap css
let assets = [Asset {
    path: env::current_dir()
        .unwrap()
        .join("test_suite")
        .join("src/template/css/bootstrap.min.css"),
    r#type: AssetType::Style,
}];

// define the print options
let print_options = PrintOptions {
    paper_width: Some(210.0), // A4 paper size in mm
    paper_height: Some(297.0), // A4 paper size in mm
    margin_top: Some(10.0), // 10mm margin
    margin_bottom: Some(10.0), // 10mm margin
    margin_left: Some(10.0), // 10mm margin
    margin_right: Some(10.0), // 10mm margin
    ..PrintOptions::default()
};

// generate the pdf file
let pdf_buf = example.generate_pdf(html_path, &assets, &print_options).await;
tokio::fs::write("example.pdf", pdf_buf).await.expect("Unable to write file");

} ```

In the HTML file write this:

html <inject-table items="my_table"> <inject-column prop="index" label="#" /> <inject-column prop="name" label="Name" /> <inject-column prop="surname" label="Surname" /> <inject-column prop="email" label="Email" /> </inject-table>

API

Macros

| Macro | Purpose | HTML use | | -------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | PdfTemplate | Define the struct that contains the values for the HTML placeholders | %%prop_name%% | | PdfTableData | Define the data for the table. Must be a vector of serde::Serialize struct | <inject-table items="prop_name">
    <inject-column prop="struct_prop_name" label="Something"/>
</inject-table> |

generate_pdf

rust async generate_pdf( html_path: std::path::PathBuf, assets: &[simple_pdf_generator::Asset], print_options: &simple_pdf_generator::PrintOptions ) -> std::result::Result<Vec<u8>, simple_pdf_generator::SimplePdfGeneratorError>

returns the PDF file as a Vec<u8>.

| Parameter | Description | | ---------------------------------------------------- | ------------------------------------------------------------ | | html_path: std::path::PathBuf | PDF output dir | | assets: &[simple_pdf_generator::Asset] | Vector of assets (it can be empty vec![]) | | print_options: &simple_pdf_generator::PrintOptions | Print options (has default values PrintOptions::default()) |

simple_pdf_generator::SimplePdfGeneratorError

rust enum SimplePdfGeneratorError { BrowserError(String), IoError(String), PdfError(String), }

simple_pdf_generator::{Asset, AssetType}

```rust struct Asset { pub path: PathBuf, pub r#type: AssetType, }

enum AssetType { Style, Script, } ```

 simple_pdf_generator::PrintOptions

rust struct PrintOptions { pub print_background: bool, pub paper_width: Option<f64>, pub paper_height: Option<f64>, pub margin_top: Option<f64>, pub margin_bottom: Option<f64>, pub margin_left: Option<f64>, pub margin_right: Option<f64>, pub page_ranges: Option<String>, pub prefer_css_page_size: bool, pub landscape: bool, }

People

This library is developed by:

License

MIT