# Simple PDF Generator Rust library that converts HTML5 files to PDFs. That's the Rust version of [simple-pdf-generator](https://github.com/lorenzinigiovanni/simple-pdf-generator) ## Installation This is a Rust library available through [crates.io](https://crates.io/crates/simple_pdf_generator). Installation is done using cargo add command: ```sh $ cargo add simple_pdf_generator ``` ## Features Simple PDF Generator: - supports `Option` types; - supports custom CSS and JS; - fills custom fields in the HTML template; - sanitizes the values to prevent XSS attacks; - can generate dynamic tables automatically. ## Limitations - Due to [`chromiumoxide`](https://github.com/mattsse/chromiumoxide#fetcher) that doesn't implement auto download of a Chromium based browser, you must install it manually ## Quick Start In order to have a template you must create struct with `PdfTemplate` derive: ```rust use simple_pdf_generator::{Asset, AssetType}; use simple_pdf_generator_derive::PdfTemplate; struct Example { id: i64, name: Option, opt_value: Option, surname: String, is_true: bool, } ``` And add the HTML file: ```html

%%id%%

Name

%%name%%

Opt Value

%%opt_value%%

Surname

%%surname%%

Is True

%%is_true%%

``` Now you can use the `Example` struct to generate the PDF file: ```rust use std::env; use simple_pdf_generator::{Asset, AssetType}; use simple_pdf_generator_derive::PdfTemplate; #[tokio::main] async fn main() { // fill the struct let example = Example { id: 1, name: Some("Foo".to_string()), opt_value: None, surname: "Bar".to_string(), is_true: 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 simple_pdf_generator::{Asset, AssetType}; use simple_pdf_generator_derive::PdfTemplate; struct Example { id: i64, name: Option, opt_value: Option, surname: String, is_true: 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".to_string()), opt_value: None, surname: "Bar".to_string(), is_true: true, my_table: vec![ MyTableData { index: 1, name: "James".to_string(), surname: "Smith".to_string(), email: "james.smith@evilcorp.tech".to_string(), }, MyTableData { index: 2, name: "Robert".to_string(), surname: "Johnson".to_string(), 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

``` ## 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 | ``
``
`` | ### `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, simple_pdf_generator::SimplePdfGeneratorError> ``` returns the PDF file as a `Vec`. | 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, pub paper_height: Option, pub margin_top: Option, pub margin_bottom: Option, pub margin_left: Option, pub margin_right: Option, pub page_ranges: Option, pub prefer_css_page_size: bool, pub landscape: bool, } ``` ## People This library is developed by: - [@MassimilianoMontagni](https://github.com/Massimiliano-solutiontech) [solutiontech.tech](https://www.solutiontech.tech/) ## License [MIT](LICENSE)